name | data type | constraints | description |
---|---|---|---|
guid | string | ||
ver | number | ||
nameAndGuid | NameAndGuid | ||
name | string | ||
millisSinceLocalMidnight | number | required | |
startWindowLength | number | required | |
active | boolean | required | |
lastRun | number | ||
nameGuidAndType | NameGuidAndType | ||
lastSupposedRun | number | ||
type | ScheduleType | ||
executionType | ScheduleExecutionType | ||
backupType | BackupType | ||
daysOfWeek | array of MyDayOfWeek | ||
dayOfWeekOccurrences | array of DayOfWeekOccurrence | ||
months | array of Month | ||
rules | array of Rule | ||
interval | ScheduleInterval | ||
projects | array of Project | ||
visibleForAllProjects | boolean | required | |
buildInType | BuildInType | ||
forceFullBackup | boolean | required | |
auditEntityName | string | ||
startTime | number | required |
Example
{ "guid" : "...", "ver" : 12345, "nameAndGuid" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "name" : "...", "millisSinceLocalMidnight" : 12345, "startWindowLength" : 12345, "active" : true, "lastRun" : 12345, "nameGuidAndType" : { "type" : { "name" : "ENUM_NAME", "description" : "Enum description" }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "lastSupposedRun" : 12345, "type" : "VM_BACKUP", "executionType" : "INTERVAL", "backupType" : "FULL", "daysOfWeek" : [ "FRIDAY", "TUESDAY" ], "dayOfWeekOccurrences" : [ "FOURTH_IN_MONTH", "FIRST_IN_MONTH" ], "months" : [ "APRIL", "DECEMBER" ], "rules" : [ { "name" : "...", "schedules" : [ { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "millisSinceLocalMidnight" : 12345, "startWindowLength" : 12345, "active" : true, "lastRun" : 12345, "nameGuidAndType" : { }, "lastSupposedRun" : 12345, "type" : "VM_RESTORE", "executionType" : "TIME", "backupType" : "SYNTHETIC", "daysOfWeek" : [ "THURSDAY", "TUESDAY" ], "dayOfWeekOccurrences" : [ "LAST_IN_MONTH", "THIRD_IN_MONTH" ], "months" : [ "DECEMBER", "JANUARY" ], "rules" : [ { }, { } ], "interval" : { }, "projects" : [ { }, { } ], "visibleForAllProjects" : true, "buildInType" : "OVIRT_RHV_DB_BACKUP", "forceFullBackup" : true, "auditEntityName" : "...", "startTime" : 12345 }, { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "millisSinceLocalMidnight" : 12345, "startWindowLength" : 12345, "active" : true, "lastRun" : 12345, "nameGuidAndType" : { }, "lastSupposedRun" : 12345, "type" : "VM_BACKUP", "executionType" : "INTERVAL", "backupType" : "FULL", "daysOfWeek" : [ "SUNDAY", "WEDNESDAY" ], "dayOfWeekOccurrences" : [ "FOURTH_IN_MONTH", "SECOND_IN_MONTH" ], "months" : [ "JUNE", "JANUARY" ], "rules" : [ { }, { } ], "interval" : { }, "projects" : [ { }, { } ], "visibleForAllProjects" : true, "buildInType" : "REAR_BACKUP", "forceFullBackup" : true, "auditEntityName" : "...", "startTime" : 12345 } ], "policy" : { "guid" : "...", "name" : "...", "ver" : 12345, "priority" : 12345, "backupRetryCount" : 12345, "autoAssignSettings" : { }, "autoRemoveNonPresent" : true, "active" : true, "buildInType" : "REAR_BACKUP", "rules" : [ { }, { } ], "visibleForAllProjects" : true, "projects" : [ { }, { } ], "nameAndGuid" : { }, "nameGuidAndType" : { }, "auditEntityName" : "..." }, "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "nameGuidAndType" : { "type" : { }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" } }, { "name" : "...", "schedules" : [ { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "millisSinceLocalMidnight" : 12345, "startWindowLength" : 12345, "active" : true, "lastRun" : 12345, "nameGuidAndType" : { }, "lastSupposedRun" : 12345, "type" : "VM_BACKUP", "executionType" : "TIME", "backupType" : "SYNCHRONIZATION", "daysOfWeek" : [ "WEDNESDAY", "TUESDAY" ], "dayOfWeekOccurrences" : [ "LAST_IN_MONTH", "SECOND_IN_MONTH" ], "months" : [ "OCTOBER", "JULY" ], "rules" : [ { }, { } ], "interval" : { }, "projects" : [ { }, { } ], "visibleForAllProjects" : true, "buildInType" : "MYSQL_MARIADB_DB_BACKUP", "forceFullBackup" : true, "auditEntityName" : "...", "startTime" : 12345 }, { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "millisSinceLocalMidnight" : 12345, "startWindowLength" : 12345, "active" : true, "lastRun" : 12345, "nameGuidAndType" : { }, "lastSupposedRun" : 12345, "type" : "CLOUD_BACKUP", "executionType" : "INTERVAL", "backupType" : "INCREMENTAL", "daysOfWeek" : [ "FRIDAY", "SUNDAY" ], "dayOfWeekOccurrences" : [ "SECOND_IN_MONTH", "LAST_IN_MONTH" ], "months" : [ "MAY", "JUNE" ], "rules" : [ { }, { } ], "interval" : { }, "projects" : [ { }, { } ], "visibleForAllProjects" : true, "buildInType" : "VPROTECT_GIT_REPOSITORY_BACKUP", "forceFullBackup" : true, "auditEntityName" : "...", "startTime" : 12345 } ], "policy" : { "guid" : "...", "name" : "...", "ver" : 12345, "priority" : 12345, "backupRetryCount" : 12345, "autoAssignSettings" : { }, "autoRemoveNonPresent" : true, "active" : true, "buildInType" : "REAR_BACKUP", "rules" : [ { }, { } ], "visibleForAllProjects" : true, "projects" : [ { }, { } ], "nameAndGuid" : { }, "nameGuidAndType" : { }, "auditEntityName" : "..." }, "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { "guid" : "...", "name" : "..." }, "nameGuidAndType" : { "type" : { }, "guid" : "...", "name" : "..." } } ], "interval" : { "startLocalTime" : 12345, "endLocalTime" : 12345, "frequency" : 12345 }, "projects" : [ { "uuid" : "...", "name" : "...", "active" : true, "present" : true, "hvManager" : { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { }, "url" : "...", "type" : "HYPERV", "nodeConfig" : { }, "user" : "...", "sshKeyPath" : "...", "useToken" : true, "sshPort" : 12345, "lastInventorySyncDate" : 12345, "lastSuccessfulInventorySyncDate" : 12345, "hypervisors" : [ { }, { } ], "vms" : [ { }, { } ], "dataCenters" : [ { }, { } ], "projects" : [ { }, { } ], "vmExportImportMode" : "CHANGED_BLOCK_TRACKING", "baseImageCreationConfig" : { }, "account" : "...", "storageType" : "DEFAULT", "useNetcat" : true, "region" : "...", "ovmSettings" : { }, "rhvSettings" : { }, "awsSettings" : { }, "vmwareSettings" : { }, "openStackSettings" : { }, "nutanixSettings" : { }, "oadpSettings" : { }, "hvmHypervSettings" : { }, "hvmAzureSettings" : { }, "gcpSettings" : { }, "endpointInterfaceType" : "INTERNAL", "version" : "...", "subtype" : "OTHER", "authenticationDomains" : [ { }, { } ], "hypervisorClusters" : [ { }, { } ], "trustAllCerts" : true, "password" : "...", "accessKey" : "...", "secretKey" : "...", "auditEntityName" : "...", "anyManagementEntityFromPool" : { }, "pool" : { }, "networks" : [ { }, { } ] }, "backupDestinations" : [ { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "modificationTime" : 12345, "dedupEnabled" : true, "totalAvailableSpace" : 12345, "totalUsedSpace" : 12345, "totalDedupUsedSpace" : 12345, "totalDedupAvailableSpace" : 12345, "visibleForAllVms" : true, "backupDestinationForCloud" : true, "trustAllCerts" : true, "nodeConfigs" : [ { }, { } ], "projects" : [ { }, { } ], "backupDestinationBackups" : [ { }, { } ], "ruleBackupDestinations" : [ { }, { } ], "type" : "VSTOR", "preAccessCmdArgs" : [ "...", "..." ], "postAccessCmdArgs" : [ "...", "..." ], "preAccessCmdExecEnabled" : true, "postAccessCmdExecEnabled" : true, "preAccessCmdExecTimeout" : 12345, "postAccessCmdExecTimeout" : 12345, "backupDestinationInitInfos" : [ { }, { } ], "initRequired" : true, "encryptionEnabled" : true, "warnings" : [ "...", "..." ], "defaultBackupDestination" : true, "spaceThreshold" : 12345, "description" : "...", "state" : "INITIALIZED", "auditEntityName" : "...", "nameGuidAndType" : { }, "randomAccessSupported" : true, "backups" : [ { }, { } ], "synthetic" : true, "tapePool" : true, "assignedToPolicyRules" : true }, { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "modificationTime" : 12345, "dedupEnabled" : true, "totalAvailableSpace" : 12345, "totalUsedSpace" : 12345, "totalDedupUsedSpace" : 12345, "totalDedupAvailableSpace" : 12345, "visibleForAllVms" : true, "backupDestinationForCloud" : true, "trustAllCerts" : true, "nodeConfigs" : [ { }, { } ], "projects" : [ { }, { } ], "backupDestinationBackups" : [ { }, { } ], "ruleBackupDestinations" : [ { }, { } ], "type" : "SWIFT", "preAccessCmdArgs" : [ "...", "..." ], "postAccessCmdArgs" : [ "...", "..." ], "preAccessCmdExecEnabled" : true, "postAccessCmdExecEnabled" : true, "preAccessCmdExecTimeout" : 12345, "postAccessCmdExecTimeout" : 12345, "backupDestinationInitInfos" : [ { }, { } ], "initRequired" : true, "encryptionEnabled" : true, "warnings" : [ "...", "..." ], "defaultBackupDestination" : true, "spaceThreshold" : 12345, "description" : "...", "state" : "INITIALIZED", "auditEntityName" : "...", "nameGuidAndType" : { }, "randomAccessSupported" : true, "backups" : [ { }, { } ], "synthetic" : true, "tapePool" : true, "assignedToPolicyRules" : true } ], "guid" : "...", "ver" : 12345, "hypervisorClusters" : [ { "uuid" : "...", "name" : "...", "visibleForAllProjects" : true, "hvManager" : { }, "dataCenter" : { }, "guid" : "...", "storages" : [ { }, { } ], "ver" : 12345, "hypervisors" : [ { }, { } ], "networks" : [ { }, { } ], "projects" : [ { }, { } ], "nodeConfig" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "uuid" : "...", "name" : "...", "visibleForAllProjects" : true, "hvManager" : { }, "dataCenter" : { }, "guid" : "...", "storages" : [ { }, { } ], "ver" : 12345, "hypervisors" : [ { }, { } ], "networks" : [ { }, { } ], "projects" : [ { }, { } ], "nodeConfig" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "hypervisorStorages" : [ { "uuid" : "...", "name" : "...", "totalUsedSpace" : 12345, "totalAvailableSpace" : 12345, "visibleForAllProjects" : true, "guid" : "...", "projects" : [ { }, { } ], "ver" : 12345, "type" : "AZURE_FILE", "hypervisor" : { }, "hvManager" : { }, "vmDisks" : [ { }, { } ], "clusters" : [ { }, { } ], "storagePool" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "uuid" : "...", "name" : "...", "totalUsedSpace" : 12345, "totalAvailableSpace" : 12345, "visibleForAllProjects" : true, "guid" : "...", "projects" : [ { }, { } ], "ver" : 12345, "type" : "LVM", "hypervisor" : { }, "hvManager" : { }, "vmDisks" : [ { }, { } ], "clusters" : [ { }, { } ], "storagePool" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "quota" : { "name" : "...", "active" : true, "rules" : [ { }, { } ], "projects" : [ { }, { } ], "guid" : "...", "hypervisorManager" : { }, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "authenticationDomains" : [ { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "sourceAuthenticationDomain" : { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, "auditEntityName" : "...", "availableAuthenticationDomain" : { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, "nameAndGuid" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "nameGuidAndType" : { "type" : { }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" } }, { "uuid" : "...", "name" : "...", "active" : true, "present" : true, "hvManager" : { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { }, "url" : "...", "type" : "RHV", "nodeConfig" : { }, "user" : "...", "sshKeyPath" : "...", "useToken" : true, "sshPort" : 12345, "lastInventorySyncDate" : 12345, "lastSuccessfulInventorySyncDate" : 12345, "hypervisors" : [ { }, { } ], "vms" : [ { }, { } ], "dataCenters" : [ { }, { } ], "projects" : [ { }, { } ], "vmExportImportMode" : "SSH_TRANSFER", "baseImageCreationConfig" : { }, "account" : "...", "storageType" : "CEPH", "useNetcat" : true, "region" : "...", "ovmSettings" : { }, "rhvSettings" : { }, "awsSettings" : { }, "vmwareSettings" : { }, "openStackSettings" : { }, "nutanixSettings" : { }, "oadpSettings" : { }, "hvmHypervSettings" : { }, "hvmAzureSettings" : { }, "gcpSettings" : { }, "endpointInterfaceType" : "INTERNAL", "version" : "...", "subtype" : "RHV", "authenticationDomains" : [ { }, { } ], "hypervisorClusters" : [ { }, { } ], "trustAllCerts" : true, "password" : "...", "accessKey" : "...", "secretKey" : "...", "auditEntityName" : "...", "anyManagementEntityFromPool" : { }, "pool" : { }, "networks" : [ { }, { } ] }, "backupDestinations" : [ { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "modificationTime" : 12345, "dedupEnabled" : true, "totalAvailableSpace" : 12345, "totalUsedSpace" : 12345, "totalDedupUsedSpace" : 12345, "totalDedupAvailableSpace" : 12345, "visibleForAllVms" : true, "backupDestinationForCloud" : true, "trustAllCerts" : true, "nodeConfigs" : [ { }, { } ], "projects" : [ { }, { } ], "backupDestinationBackups" : [ { }, { } ], "ruleBackupDestinations" : [ { }, { } ], "type" : "AZURE", "preAccessCmdArgs" : [ "...", "..." ], "postAccessCmdArgs" : [ "...", "..." ], "preAccessCmdExecEnabled" : true, "postAccessCmdExecEnabled" : true, "preAccessCmdExecTimeout" : 12345, "postAccessCmdExecTimeout" : 12345, "backupDestinationInitInfos" : [ { }, { } ], "initRequired" : true, "encryptionEnabled" : true, "warnings" : [ "...", "..." ], "defaultBackupDestination" : true, "spaceThreshold" : 12345, "description" : "...", "state" : "REQUIRED_INITIALIZATION", "auditEntityName" : "...", "nameGuidAndType" : { }, "randomAccessSupported" : true, "backups" : [ { }, { } ], "synthetic" : true, "tapePool" : true, "assignedToPolicyRules" : true }, { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "modificationTime" : 12345, "dedupEnabled" : true, "totalAvailableSpace" : 12345, "totalUsedSpace" : 12345, "totalDedupUsedSpace" : 12345, "totalDedupAvailableSpace" : 12345, "visibleForAllVms" : true, "backupDestinationForCloud" : true, "trustAllCerts" : true, "nodeConfigs" : [ { }, { } ], "projects" : [ { }, { } ], "backupDestinationBackups" : [ { }, { } ], "ruleBackupDestinations" : [ { }, { } ], "type" : "ISP", "preAccessCmdArgs" : [ "...", "..." ], "postAccessCmdArgs" : [ "...", "..." ], "preAccessCmdExecEnabled" : true, "postAccessCmdExecEnabled" : true, "preAccessCmdExecTimeout" : 12345, "postAccessCmdExecTimeout" : 12345, "backupDestinationInitInfos" : [ { }, { } ], "initRequired" : true, "encryptionEnabled" : true, "warnings" : [ "...", "..." ], "defaultBackupDestination" : true, "spaceThreshold" : 12345, "description" : "...", "state" : "INITIALIZING", "auditEntityName" : "...", "nameGuidAndType" : { }, "randomAccessSupported" : true, "backups" : [ { }, { } ], "synthetic" : true, "tapePool" : true, "assignedToPolicyRules" : true } ], "guid" : "...", "ver" : 12345, "hypervisorClusters" : [ { "uuid" : "...", "name" : "...", "visibleForAllProjects" : true, "hvManager" : { }, "dataCenter" : { }, "guid" : "...", "storages" : [ { }, { } ], "ver" : 12345, "hypervisors" : [ { }, { } ], "networks" : [ { }, { } ], "projects" : [ { }, { } ], "nodeConfig" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "uuid" : "...", "name" : "...", "visibleForAllProjects" : true, "hvManager" : { }, "dataCenter" : { }, "guid" : "...", "storages" : [ { }, { } ], "ver" : 12345, "hypervisors" : [ { }, { } ], "networks" : [ { }, { } ], "projects" : [ { }, { } ], "nodeConfig" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "hypervisorStorages" : [ { "uuid" : "...", "name" : "...", "totalUsedSpace" : 12345, "totalAvailableSpace" : 12345, "visibleForAllProjects" : true, "guid" : "...", "projects" : [ { }, { } ], "ver" : 12345, "type" : "STORAGEOS", "hypervisor" : { }, "hvManager" : { }, "vmDisks" : [ { }, { } ], "clusters" : [ { }, { } ], "storagePool" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "uuid" : "...", "name" : "...", "totalUsedSpace" : 12345, "totalAvailableSpace" : 12345, "visibleForAllProjects" : true, "guid" : "...", "projects" : [ { }, { } ], "ver" : 12345, "type" : "OPENNEBULA_SYSTEM_DS", "hypervisor" : { }, "hvManager" : { }, "vmDisks" : [ { }, { } ], "clusters" : [ { }, { } ], "storagePool" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "quota" : { "name" : "...", "active" : true, "rules" : [ { }, { } ], "projects" : [ { }, { } ], "guid" : "...", "hypervisorManager" : { }, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "authenticationDomains" : [ { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "sourceAuthenticationDomain" : { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, "auditEntityName" : "...", "availableAuthenticationDomain" : { "name" : "...", "domainId" : "...", "user" : "...", "defaultProjectName" : "...", "usedForAuthentication" : true, "present" : true, "hvManager" : { }, "auditEntityName" : "...", "password" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, "nameAndGuid" : { "guid" : "...", "name" : "..." }, "nameGuidAndType" : { "type" : { }, "guid" : "...", "name" : "..." } } ], "visibleForAllProjects" : true, "buildInType" : "INTERNAL_DB_BACKUP", "forceFullBackup" : true, "auditEntityName" : "...", "startTime" : 12345 }