name | data type | constraints | description |
---|---|---|---|
sshHost | string | ||
sshPort | number | ||
credential | CredentialDetails | ||
sshKeyPath | string | ||
backupCount | number | required | |
rules | array of NameAndGuid | ||
name | string | ||
type | ProtectedEntityType | ||
backupUpToDate | boolean | ||
restorable | boolean | required | |
lastSuccessfulBackupSize | number | ||
lastSuccessfulFullBackupSize | number | ||
warningsPresent | boolean | required | |
lastSuccessfulFullBackup | NameAndGuid | ||
lastSuccessfulIncBackup | NameAndGuid | ||
averageProgress | number | ||
lastChainMarkedForDeletion | boolean | required | |
guid | string | ||
lastBackup | number | ||
uuid | string | ||
hypervisor | HypervisorDetails | ||
hvManager | HypervisorManagerDetails | ||
resourceGroup | NameAndGuid | ||
vmBackupPolicy | VmBackupPolicyDetails | ||
snapshotMgmtPolicy | NameAndGuid | ||
present | boolean | required | |
dataCenter | NameAndGuid | ||
hvCluster | NameAndGuid | ||
array of string | |||
hvType | HypervisorType | ||
hvmType | HypervisorManagerType | ||
vmExportImportMode | VmExportImportMode | ||
preCommand | CommandDetails | ||
postCommand | CommandDetails | ||
preSnapCmdExecEnabled | boolean | required | |
postSnapCmdExecEnabled | boolean | required | |
preSnapIgnoredExitCodes | string | ||
postSnapIgnoredExitCodes | string | ||
preSnapStdErrorHandling | StdErrorHandling | ||
postSnapStdErrorHandling | StdErrorHandling | ||
preSnapCmdExecTimeout | number | ||
postSnapCmdExecTimeout | number | ||
baseImageCreationConfig | BaseImageCreationConfigDTO | ||
project | NameAndGuid | ||
externalReference | string | ||
originalName | string | ||
possibleActions | array of RbacInstanceAction | ||
networkInterfaceCards | array of NameAndGuid | ||
lastStoredSnapshotAssignments | array of VmSnapshotRuleAssignmentDetails | ||
vmResourceType | VmResourceType | ||
vmFlavor | NameAndGuid | ||
accessKey | NameAndGuid |
Example
{ "sshHost" : "...", "sshPort" : 12345, "credential" : { "guid" : "...", "name" : "...", "user" : "...", "secretKey" : "...", "sshKey" : "...", "sshKeyPath" : "...", "powerShellTransportType" : "SSL" }, "sshKeyPath" : "...", "backupCount" : 12345, "rules" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "name" : "...", "type" : "OS", "backupUpToDate" : true, "restorable" : true, "lastSuccessfulBackupSize" : 12345, "lastSuccessfulFullBackupSize" : 12345, "warningsPresent" : true, "lastSuccessfulFullBackup" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "lastSuccessfulIncBackup" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "averageProgress" : 12345.0, "lastChainMarkedForDeletion" : true, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "lastBackup" : 1451649601000, "uuid" : "...", "hypervisor" : { "host" : "...", "sshPort" : 12345, "nodeConfig" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "user" : "...", "sshKeyPath" : "...", "vmCount" : 12345, "hvManager" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "hvmType" : { "name" : "ENUM_NAME", "description" : "Enum description" }, "vmExportImportMode" : "SSH_TRANSFER", "transferNicAddress" : "...", "dataCenterName" : "...", "cluster" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "vmOwner" : "...", "vmOwningGroup" : "...", "storageType" : "DEFAULT", "storageProvider" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "licenseCovered" : true, "useNetcat" : true, "citrixSettings" : { "citrixExportRefreshRate" : 12345, "citrixEnableXvaCompression" : true, "citrixSnapshotRemovalTimeout" : 12345 }, "libvirtSettings" : { "libvirtSshTimeout" : 12345, "libvirtSshKnownHostsPath" : "...", "libvirtSshProgressRefreshRate" : 12345, "libvirtLvmSnapshotSize" : "...", "libvirtLvmSnapshotExtents" : "...", "libvirtAlwaysExportFullIfVmTurnedOff" : true }, "proxmoxSettings" : { "proxmoxBackupStorage" : "...", "proxmoxCompressionType" : "DISABLED", "proxmoxNbdBufferReleaseMaxAttempts" : 12345, "proxmoxNbdBufferReleaseTimeout" : 12345, "proxmoxNbdBufferReleaseWaitPeriod" : 12345, "proxmoxAvailableNbdWaitPeriod" : 12345, "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345 }, "hvHypervSettings" : { "hypervExportChunksNumber" : 12345, "hypevisorManagerHypervType" : "..." }, "lastInventorySyncDate" : 12345, "lastSuccessfulInventorySyncDate" : 12345, "possibleActions" : [ "HV_READ", "INVENTORY_SYNC" ], "version" : "...", "trustAllCerts" : true, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "type" : { "name" : "ENUM_NAME", "description" : "Enum description" } }, "hvManager" : { "url" : "...", "sshPort" : 12345, "nodeConfig" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "user" : "...", "sshKeyPath" : "...", "hvCount" : 12345, "vmCount" : 12345, "vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING", "baseImageCreationConfig" : { "windowsImageRequired" : "INHERIT", "linuxImageRequired" : "INHERIT" }, "account" : "...", "useNetcat" : true, "storageType" : "DEFAULT", "region" : "...", "endpointInterfaceType" : "PUBLIC", "ovmSettings" : { "ovmJobStatusPollingInterval" : 12345, "ovmPoolToRepoMappings" : [ { }, { } ], "ovmExportCloneTypeOverride" : "THIN_CLONE" }, "rhvSettings" : { "rhvSnapshotCloneTimeout" : 12345, "rhvSnapshotCreationTimeout" : 12345, "rhvVmExportTimeout" : 12345, "rhvDiskUnlockTimeout" : 12345, "rhvMultiDatacenterExport" : true, "rhvSnapshotRemovalTimeout" : 12345, "rhvDcToSdMappings" : [ { }, { } ] }, "awsSettings" : { "awsSnapshotCreationTimeout" : 12345, "awsImageCreationTimeout" : 12345, "awsVolumeActionsTimeout" : 12345, "awsInstanceCreationTimeout" : 12345 }, "vmwareSettings" : { "vmwareTagCategory" : "..." }, "openStackSettings" : { "openstackDownloadImageFromGlance" : true, "openstackScopeVmsToDomain" : true }, "nutanixSettings" : { "nutanixSnapshotRemovalTimeout" : 12345, "maxNutanixSnapshotCreatingTimeout" : 12345, "nutanixDiskOperationTimeout" : 12345 }, "oadpSettings" : { "oadpProjectName" : "...", "oadpStorageClassName" : "..." }, "hvmHypervSettings" : { "hypervExportChunksNumber" : 12345, "hypevisorManagerHypervType" : "..." }, "hvmAzureSettings" : { "azureClientId" : "...", "azureClientSecret" : "...", "azureSubscriptionId" : "...", "azureTenantId" : "..." }, "gcpSettings" : { "gcpOrganizationId" : "..." }, "useToken" : true, "lastInventorySyncDate" : 12345, "lastSuccessfulInventorySyncDate" : 12345, "possibleActions" : [ "HVM_READ", "HVM_READ" ], "version" : "...", "trustAllCerts" : true, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "type" : { "name" : "ENUM_NAME", "description" : "Enum description" } }, "resourceGroup" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "vmBackupPolicy" : { "rules" : [ { "guid" : "...", "name" : "...", "policy" : { }, "schedules" : [ { }, { } ], "vmCount" : 12345, "schedulesCount" : 12345, "position" : 12345, "active" : true, "removable" : true, "daysToKeepRetentionLock" : 12345 }, { "guid" : "...", "name" : "...", "policy" : { }, "schedules" : [ { }, { } ], "vmCount" : 12345, "schedulesCount" : 12345, "position" : 12345, "active" : true, "removable" : true, "daysToKeepRetentionLock" : 12345 } ], "name" : "...", "active" : true, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "priority" : 50, "autoAssignSettings" : { "mode" : "DISABLED", "includeRegExps" : [ "...", "..." ], "excludeRegExps" : [ "...", "..." ], "includeTags" : [ "...", "..." ], "excludeTags" : [ "...", "..." ], "hvClusters" : [ { }, { } ], "projects" : [ { }, { } ] }, "autoRemoveNonPresent" : true, "vms" : [ { "name" : "...", "type" : "CLOUD_GROUP", "backupUpToDate" : true, "restorable" : true, "uuid" : "...", "hypervisor" : { }, "lastSuccessfulBackupSize" : 12345, "hvManager" : { }, "lastSuccessfulFullBackupSize" : 12345, "dataCenter" : { }, "warningsPresent" : true, "hvCluster" : { }, "lastSuccessfulFullBackup" : { }, "vmBackupPolicy" : { }, "present" : true, "lastSuccessfulIncBackup" : { }, "hvType" : "KVM", "averageProgress" : 12345.0, "lastChainMarkedForDeletion" : true, "hvmType" : "OPENSTACK", "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "project" : { }, "lastBackup" : 1451649601000, "originalName" : "...", "restoreStatus" : "...", "possibleActions" : [ "WRITE", "INVENTORY_SYNC" ], "rule" : { }, "vmFlavor" : { }, "accessKey" : { }, "networks" : [ { }, { } ], "supportsQuiesceSnapshot" : true }, { "name" : "...", "type" : "OS_AGENT", "backupUpToDate" : true, "restorable" : true, "uuid" : "...", "hypervisor" : { }, "lastSuccessfulBackupSize" : 12345, "hvManager" : { }, "lastSuccessfulFullBackupSize" : 12345, "dataCenter" : { }, "warningsPresent" : true, "hvCluster" : { }, "lastSuccessfulFullBackup" : { }, "vmBackupPolicy" : { }, "present" : true, "lastSuccessfulIncBackup" : { }, "hvType" : "PROXMOX", "averageProgress" : 12345.0, "lastChainMarkedForDeletion" : true, "hvmType" : "ORACLE", "guid" : "...", "project" : { }, "lastBackup" : 12345, "originalName" : "...", "restoreStatus" : "...", "possibleActions" : [ "HVM_READ", "HVM_READ" ], "rule" : { }, "vmFlavor" : { }, "accessKey" : { }, "networks" : [ { }, { } ], "supportsQuiesceSnapshot" : true } ], "averageBackupSize" : 12345, "failRemainingBackupTasksExportThreshold" : 12345.0, "failRemainingBackupTasksStoreThreshold" : 12345.0, "projects" : [ { "guid" : "...", "name" : "...", "hvManager" : { }, "uuid" : "..." }, { "guid" : "...", "name" : "...", "hvManager" : { }, "uuid" : "..." } ], "visibleForAllProjects" : true, "backupRetryCount" : 12345, "dailyReportEnabled" : true, "mailingList" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "disableCleanOldBackups" : true, "quiesceBeforeSnapshot" : true }, "snapshotMgmtPolicy" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "present" : true, "dataCenter" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "hvCluster" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "tags" : [ "...", "..." ], "hvType" : "KVM", "hvmType" : "OPENSTACK", "vmExportImportMode" : "DISK_IMAGE_TRANSFER", "preCommand" : { "commandArgs" : [ "...", "..." ], "commandType" : "SSH", "executionStage" : "PRE" }, "postCommand" : { "commandArgs" : [ "...", "..." ], "commandType" : "SSH", "executionStage" : "POST" }, "preSnapCmdExecEnabled" : true, "postSnapCmdExecEnabled" : true, "preSnapIgnoredExitCodes" : "...", "postSnapIgnoredExitCodes" : "...", "preSnapStdErrorHandling" : "DONT_IGNORE", "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING", "preSnapCmdExecTimeout" : 12345, "postSnapCmdExecTimeout" : 12345, "baseImageCreationConfig" : { "windowsImageRequired" : "INHERIT", "linuxImageRequired" : "FALSE" }, "project" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "externalReference" : "...", "originalName" : "...", "possibleActions" : [ "READ", "HVM_READ" ], "networkInterfaceCards" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "lastStoredSnapshotAssignments" : [ { "protectedEntitySnapshot" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "virtualMachine" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "backupRule" : { "guid" : "...", "name" : "...", "policy" : { }, "schedules" : [ { }, { } ], "ruleBackupDestinations" : [ { }, { } ], "vmCount" : 12345, "schedulesCount" : 12345, "position" : 12345, "active" : true, "backupCount" : 12345, "removable" : true, "markedForDeletion" : true, "daysToKeepRetentionLock" : 12345 } }, { "protectedEntitySnapshot" : { "guid" : "...", "name" : "..." }, "virtualMachine" : { "guid" : "...", "name" : "..." }, "backupRule" : { "guid" : "...", "name" : "...", "policy" : { }, "schedules" : [ { }, { } ], "ruleBackupDestinations" : [ { }, { } ], "vmCount" : 12345, "schedulesCount" : 12345, "position" : 12345, "active" : true, "backupCount" : 12345, "removable" : true, "markedForDeletion" : true, "daysToKeepRetentionLock" : 12345 } } ], "vmResourceType" : "UNDEFINED", "vmFlavor" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "accessKey" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" } }