name | data type | constraints | description |
---|---|---|---|
retentionVersions | number | required | |
policy | VmSnapshotMgmtPolicy | ||
snapshots | array of ProtectedEntitySnapshot | ||
retentionDays | number | required | |
name | string | ||
schedules | array of Schedule | ||
guid | string | ||
position | number | ||
ver | number | ||
auditEntityName | string | ||
nameAndGuid | NameAndGuid | ||
nameGuidAndType | NameGuidAndType |
Example
{ "retentionVersions" : 12345, "policy" : { "auditEntityName" : "...", "vms" : [ { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "sshHost" : "...", "sshPort" : 12345, "lastSuccessfulFullBackupSizeForFETB" : 12345, "type" : "CLOUD_GROUP", "lastSuccessfulFullBackup" : { }, "lastRestoreJob" : { }, "lastSuccessfulIncBackup" : { }, "lastStoredSnapshotAssignments" : [ { }, { } ], "backups" : [ { }, { } ], "uuid" : "...", "externalReference" : "...", "preSnapIgnoredExitCodes" : "...", "postSnapIgnoredExitCodes" : "...", "warningsPresent" : true, "originalName" : "...", "buildInType" : "MSSQL_DB_BACKUP", "parentFolderName" : "...", "preSnapCmdExecEnabled" : true, "credential" : { }, "postSnapCmdExecEnabled" : true, "averageProgress" : 12345.0, "preSnapCmdExecTimeout" : 12345, "lastChainMarkedForDeletion" : true, "postSnapCmdExecTimeout" : 12345, "specialOperation" : "DISCARD_METADATA_DATABASES", "supportsQuiesceSnapshot" : true, "lastSuccessfulBackup" : { }, "preCommand" : { }, "postCommand" : { }, "dataCenter" : { }, "hvCluster" : { }, "baseImageCreationConfig" : { }, "hypervisor" : { }, "vmBackupPolicy" : { }, "snapshotMgmtPolicy" : { }, "project" : { }, "nameGuidAndType" : { }, "tags" : [ { }, { } ], "hvType" : "OPENSHIFT", "hvmType" : "KUBERNETES", "vmExportImportMode" : "CHANGED_BLOCK_TRACKING", "lastStoredSnapshot" : { }, "preSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING", "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING", "networkInterfaceCards" : [ { }, { } ], "lastStoredSnapshots" : [ { }, { } ], "vmResourceType" : "VIRTUAL_MACHINE", "vmFlavor" : { }, "accessKey" : { }, "present" : true, "auditEntityName" : "...", "backupPolicy" : { }, "typeDeletable" : true, "nodeConfig" : { }, "bounded" : true, "backupDestinationsByBackups" : [ { }, { } ], "hvManager" : { }, "incrementalBackupOutdatedByRuleBackupDestinationChange" : true, "anyHypervisorClusterFromStructure" : { }, "cloud" : true, "VMInDiskAttachmentCbtExportMode" : true, "VMInCBTExportMode" : true, "effectiveVmExportImportMode" : "DISK_ATTACHMENT", "storageProviderIfPresent" : { }, "peProviderForSystemNotification" : { } }, { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "sshHost" : "...", "sshPort" : 12345, "lastSuccessfulFullBackupSizeForFETB" : 12345, "type" : "VM", "lastSuccessfulFullBackup" : { }, "lastRestoreJob" : { }, "lastSuccessfulIncBackup" : { }, "lastStoredSnapshotAssignments" : [ { }, { } ], "backups" : [ { }, { } ], "uuid" : "...", "externalReference" : "...", "preSnapIgnoredExitCodes" : "...", "postSnapIgnoredExitCodes" : "...", "warningsPresent" : true, "originalName" : "...", "buildInType" : "OVIRT_RHV_DB_BACKUP", "parentFolderName" : "...", "preSnapCmdExecEnabled" : true, "credential" : { }, "postSnapCmdExecEnabled" : true, "averageProgress" : 12345.0, "preSnapCmdExecTimeout" : 12345, "lastChainMarkedForDeletion" : true, "postSnapCmdExecTimeout" : 12345, "specialOperation" : "DISCARD_METADATA_DATABASES", "supportsQuiesceSnapshot" : true, "lastSuccessfulBackup" : { }, "preCommand" : { }, "postCommand" : { }, "dataCenter" : { }, "hvCluster" : { }, "baseImageCreationConfig" : { }, "hypervisor" : { }, "vmBackupPolicy" : { }, "snapshotMgmtPolicy" : { }, "project" : { }, "nameGuidAndType" : { }, "tags" : [ { }, { } ], "hvType" : "PROXMOX", "hvmType" : "KUBERNETES", "vmExportImportMode" : "CHANGED_BLOCK_TRACKING", "lastStoredSnapshot" : { }, "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING", "postSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING", "networkInterfaceCards" : [ { }, { } ], "lastStoredSnapshots" : [ { }, { } ], "vmResourceType" : "VIRTUAL_MACHINE", "vmFlavor" : { }, "accessKey" : { }, "present" : true, "auditEntityName" : "...", "backupPolicy" : { }, "typeDeletable" : true, "nodeConfig" : { }, "bounded" : true, "backupDestinationsByBackups" : [ { }, { } ], "hvManager" : { }, "incrementalBackupOutdatedByRuleBackupDestinationChange" : true, "anyHypervisorClusterFromStructure" : { }, "cloud" : true, "VMInDiskAttachmentCbtExportMode" : true, "VMInCBTExportMode" : true, "effectiveVmExportImportMode" : "INHERIT", "storageProviderIfPresent" : { }, "peProviderForSystemNotification" : { } } ], "guid" : "...", "name" : "...", "ver" : 12345, "rules" : [ { "retentionVersions" : 12345, "policy" : { }, "snapshots" : [ { }, { } ], "retentionDays" : 12345, "name" : "...", "schedules" : [ { }, { } ], "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "retentionVersions" : 12345, "policy" : { }, "snapshots" : [ { }, { } ], "retentionDays" : 12345, "name" : "...", "schedules" : [ { }, { } ], "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "priority" : 12345, "backupRetryCount" : 12345, "autoAssignSettings" : { "guid" : "...", "ver" : 12345, "policy" : { }, "mode" : "ASSIGN_AND_REMOVE", "regExps" : [ { }, { } ], "tags" : [ { }, { } ], "hvClusters" : [ { }, { } ], "nameAndGuid" : { }, "storagePools" : [ { }, { } ], "nameGuidAndType" : { }, "cloudServiceProviders" : [ { }, { } ], "osAgents" : [ { }, { } ], "projects" : [ { }, { } ], "auditEntityName" : "..." }, "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" : { } } ], "autoRemoveNonPresent" : true, "active" : true, "buildInType" : "DB2_BACKUP", "visibleForAllProjects" : true, "protectedEntities" : [ { "nameGuidAndType" : { }, "nodeConfig" : { }, "present" : true, "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "sshHost" : "...", "lastSuccessfulFullBackupSizeForFETB" : 12345, "type" : "CLOUD_SITE", "lastSuccessfulIncBackup" : { }, "warningsPresent" : true, "buildInType" : "REAR_BACKUP", "credential" : { }, "lastChainMarkedForDeletion" : true, "bounded" : true, "snapshotMgmtPolicy" : { }, "typeDeletable" : true, "lastStoredSnapshots" : [ { }, { } ], "storageProviderIfPresent" : { }, "backupDestinationsByBackups" : [ { }, { } ], "sshPort" : 12345, "lastSuccessfulFullBackup" : { }, "backups" : [ { }, { } ], "specialOperation" : "DISCARD_METADATA_DATABASES", "lastStoredSnapshot" : { }, "backupPolicy" : { }, "cloud" : true, "auditEntityName" : "...", "lastRestoreJob" : { }, "lastStoredSnapshotAssignments" : [ { }, { } ], "averageProgress" : 12345.0, "lastSuccessfulBackup" : { } }, { "nameGuidAndType" : { }, "nodeConfig" : { }, "present" : true, "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "sshHost" : "...", "lastSuccessfulFullBackupSizeForFETB" : 12345, "type" : "CLOUD_SITE", "lastSuccessfulIncBackup" : { }, "warningsPresent" : true, "buildInType" : "REAR_BACKUP", "credential" : { }, "lastChainMarkedForDeletion" : true, "bounded" : true, "snapshotMgmtPolicy" : { }, "typeDeletable" : true, "lastStoredSnapshots" : [ { }, { } ], "storageProviderIfPresent" : { }, "backupDestinationsByBackups" : [ { }, { } ], "sshPort" : 12345, "lastSuccessfulFullBackup" : { }, "backups" : [ { }, { } ], "specialOperation" : "DISCARD_METADATA_DATABASES", "lastStoredSnapshot" : { }, "backupPolicy" : { }, "cloud" : true, "auditEntityName" : "...", "lastRestoreJob" : { }, "lastStoredSnapshotAssignments" : [ { }, { } ], "averageProgress" : 12345.0, "lastSuccessfulBackup" : { } } ], "nameAndGuid" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "rule" : { "retentionVersions" : 12345, "policy" : { }, "snapshots" : [ { }, { } ], "retentionDays" : 12345, "name" : "...", "schedules" : [ { }, { } ], "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "nameGuidAndType" : { "type" : { }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" } }, "snapshots" : [ { "guid" : "...", "snapshotTime" : 12345, "ver" : 12345, "uuid" : "...", "protectedEntity" : { "nameGuidAndType" : { }, "nodeConfig" : { }, "present" : true, "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "sshHost" : "...", "lastSuccessfulFullBackupSizeForFETB" : 12345, "type" : "VM", "lastSuccessfulIncBackup" : { }, "warningsPresent" : true, "buildInType" : "ETCD_BACKUP", "credential" : { }, "lastChainMarkedForDeletion" : true, "bounded" : true, "snapshotMgmtPolicy" : { }, "typeDeletable" : true, "lastStoredSnapshots" : [ { }, { } ], "storageProviderIfPresent" : { }, "backupDestinationsByBackups" : [ { }, { } ], "sshPort" : 12345, "lastSuccessfulFullBackup" : { }, "backups" : [ { }, { } ], "specialOperation" : "DISCARD_METADATA_DATABASES", "lastStoredSnapshot" : { }, "backupPolicy" : { }, "cloud" : true, "auditEntityName" : "...", "lastRestoreJob" : { }, "lastStoredSnapshotAssignments" : [ { }, { } ], "averageProgress" : 12345.0, "lastSuccessfulBackup" : { } }, "lastStoredSnapshotAssignments" : [ { "protectedEntity" : { }, "protectedEntitySnapshot" : { }, "backupRule" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "protectedEntity" : { }, "protectedEntitySnapshot" : { }, "backupRule" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "status" : "REMOVED", "vmSnapshotMgmtRule" : { "retentionVersions" : 12345, "policy" : { }, "snapshots" : [ { }, { } ], "retentionDays" : 12345, "name" : "...", "schedules" : [ { }, { } ], "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "storageSnapshotMgmtRule" : { "retentionVersions" : 12345, "policy" : { }, "retentionDays" : 12345, "snapshots" : [ { }, { } ], "name" : "...", "schedules" : [ { }, { } ], "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "warnings" : [ { "message" : "...", "backup" : { }, "restoreJob" : { }, "snapshot" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "message" : "...", "backup" : { }, "restoreJob" : { }, "snapshot" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "warningsPresent" : true, "metadata" : "...", "firstRemovalAttempt" : 12345, "lastRemovalAttempt" : 12345, "numberOfRemovalAttempts" : 12345, "numberOfDaysRemovalAttempts" : 12345, "nameAndGuid" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "standAlone" : true, "nameGuidAndType" : { "type" : { }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "auditEntityName" : "..." }, { "guid" : "...", "snapshotTime" : 12345, "ver" : 12345, "uuid" : "...", "protectedEntity" : { "nameGuidAndType" : { }, "nodeConfig" : { }, "present" : true, "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "name" : "...", "sshHost" : "...", "lastSuccessfulFullBackupSizeForFETB" : 12345, "type" : "STORAGE", "lastSuccessfulIncBackup" : { }, "warningsPresent" : true, "buildInType" : "POSTGRESQL_DB_BACKUP", "credential" : { }, "lastChainMarkedForDeletion" : true, "bounded" : true, "snapshotMgmtPolicy" : { }, "typeDeletable" : true, "lastStoredSnapshots" : [ { }, { } ], "storageProviderIfPresent" : { }, "backupDestinationsByBackups" : [ { }, { } ], "sshPort" : 12345, "lastSuccessfulFullBackup" : { }, "backups" : [ { }, { } ], "specialOperation" : "DISCARD_METADATA_DATABASES", "lastStoredSnapshot" : { }, "backupPolicy" : { }, "cloud" : true, "auditEntityName" : "...", "lastRestoreJob" : { }, "lastStoredSnapshotAssignments" : [ { }, { } ], "averageProgress" : 12345.0, "lastSuccessfulBackup" : { } }, "lastStoredSnapshotAssignments" : [ { "protectedEntity" : { }, "protectedEntitySnapshot" : { }, "backupRule" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "protectedEntity" : { }, "protectedEntitySnapshot" : { }, "backupRule" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "status" : "CREATING", "vmSnapshotMgmtRule" : { "retentionVersions" : 12345, "policy" : { }, "snapshots" : [ { }, { } ], "retentionDays" : 12345, "name" : "...", "schedules" : [ { }, { } ], "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "storageSnapshotMgmtRule" : { "retentionVersions" : 12345, "policy" : { }, "retentionDays" : 12345, "snapshots" : [ { }, { } ], "name" : "...", "schedules" : [ { }, { } ], "guid" : "...", "position" : 12345, "ver" : 12345, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "warnings" : [ { "message" : "...", "backup" : { }, "restoreJob" : { }, "snapshot" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "message" : "...", "backup" : { }, "restoreJob" : { }, "snapshot" : { }, "auditEntityName" : "...", "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "warningsPresent" : true, "metadata" : "...", "firstRemovalAttempt" : 12345, "lastRemovalAttempt" : 12345, "numberOfRemovalAttempts" : 12345, "numberOfDaysRemovalAttempts" : 12345, "nameAndGuid" : { "guid" : "...", "name" : "..." }, "standAlone" : true, "nameGuidAndType" : { "type" : { }, "guid" : "...", "name" : "..." }, "auditEntityName" : "..." } ], "retentionDays" : 12345, "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" : "VM_SNAPSHOT", "executionType" : "TIME", "backupType" : "FULL", "daysOfWeek" : [ "FRIDAY", "SATURDAY" ], "dayOfWeekOccurrences" : [ "LAST_IN_MONTH", "FIRST_IN_MONTH" ], "months" : [ "DECEMBER", "MARCH" ], "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 }, { "guid" : "...", "ver" : 12345, "nameAndGuid" : { "guid" : "...", "name" : "..." }, "name" : "...", "millisSinceLocalMidnight" : 12345, "startWindowLength" : 12345, "active" : true, "lastRun" : 12345, "nameGuidAndType" : { "type" : { }, "guid" : "...", "name" : "..." }, "lastSupposedRun" : 12345, "type" : "VM_SNAPSHOT", "executionType" : "INTERVAL", "backupType" : "SYNCHRONIZATION", "daysOfWeek" : [ "MONDAY", "MONDAY" ], "dayOfWeekOccurrences" : [ "LAST_IN_MONTH", "LAST_IN_MONTH" ], "months" : [ "NOVEMBER", "AUGUST" ], "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" : "DB2_BACKUP", "forceFullBackup" : true, "auditEntityName" : "...", "startTime" : 12345 } ], "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" } }