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 | ||
uuid | string | ||
size | number | required | |
lastSuccessfulIncBackup | NameAndGuid | ||
snapshotable | boolean | required | |
storageProvider | NameAndGuid | ||
averageProgress | number | ||
lastChainMarkedForDeletion | boolean | required | |
storageBackupPolicy | StorageBackupPolicyDetails | ||
guid | string | ||
snapshotMgmtPolicy | NameAndGuid | ||
storagePool | NameAndGuid | ||
storageProviderType | StorageProviderType | ||
lastBackup | number | ||
present | boolean | required | |
path | string | ||
description | string | ||
possibleActions | array of RbacInstanceAction | ||
lastStoredSnapshotAssignments | array of StorageSnapshotRuleAssignmentDetails | ||
preCommand | CommandDetails | ||
postCommand | CommandDetails | ||
preSnapCmdExecEnabled | boolean | required | |
postSnapCmdExecEnabled | boolean | required | |
preSnapIgnoredExitCodes | string | ||
postSnapIgnoredExitCodes | string | ||
preSnapStdErrorHandling | StdErrorHandling | ||
postSnapStdErrorHandling | StdErrorHandling | ||
preSnapCmdExecTimeout | number | ||
postSnapCmdExecTimeout | number | ||
nodeConfig | NameAndGuid |
Example
{ "sshHost" : "...", "sshPort" : 12345, "credential" : { "guid" : "...", "name" : "...", "user" : "...", "secretKey" : "...", "sshKey" : "...", "sshKeyPath" : "...", "powerShellTransportType" : "KERBEROS" }, "sshKeyPath" : "...", "backupCount" : 12345, "rules" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "name" : "...", "type" : "CLOUD_USER", "backupUpToDate" : true, "restorable" : true, "lastSuccessfulBackupSize" : 12345, "lastSuccessfulFullBackupSize" : 12345, "warningsPresent" : true, "lastSuccessfulFullBackup" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "uuid" : "...", "size" : 12345, "lastSuccessfulIncBackup" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "snapshotable" : true, "storageProvider" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "averageProgress" : 12345.0, "lastChainMarkedForDeletion" : true, "storageBackupPolicy" : { "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, "autoAssignSettings" : { "mode" : "ASSIGN_ONLY", "includeRegExps" : [ "...", "..." ], "excludeRegExps" : [ "...", "..." ], "storagePools" : [ { }, { } ] }, "backupRetryCount" : 12345, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "autoRemoveNonPresent" : true, "storages" : [ { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, { "guid" : "...", "name" : "..." } ], "averageBackupSize" : 12345, "priority" : 50, "failRemainingBackupTasksExportThreshold" : 12345.0, "failRemainingBackupTasksStoreThreshold" : 12345.0, "dailyReportEnabled" : true, "mailingList" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "disableCleanOldBackups" : true }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "snapshotMgmtPolicy" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "storagePool" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "storageProviderType" : "DEFAULT", "lastBackup" : 1451649601000, "present" : true, "path" : "...", "description" : "...", "possibleActions" : [ "INVENTORY_SYNC", "WRITE" ], "lastStoredSnapshotAssignments" : [ { "protectedEntitySnapshot" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "storage" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "backupRule" : { "guid" : "...", "name" : "...", "policy" : { }, "schedules" : [ { }, { } ], "vmCount" : 12345, "schedulesCount" : 12345, "position" : 12345, "active" : true, "ruleBackupDestinations" : [ { }, { } ], "removable" : true, "daysToKeepRetentionLock" : 12345, "backupCount" : 12345, "markedForDeletion" : true } }, { "protectedEntitySnapshot" : { "guid" : "...", "name" : "..." }, "storage" : { "guid" : "...", "name" : "..." }, "backupRule" : { "guid" : "...", "name" : "...", "policy" : { }, "schedules" : [ { }, { } ], "vmCount" : 12345, "schedulesCount" : 12345, "position" : 12345, "active" : true, "ruleBackupDestinations" : [ { }, { } ], "removable" : true, "daysToKeepRetentionLock" : 12345, "backupCount" : 12345, "markedForDeletion" : true } } ], "preCommand" : { "commandArgs" : [ "...", "..." ], "commandType" : "SSH", "executionStage" : "PRE" }, "postCommand" : { "commandArgs" : [ "...", "..." ], "commandType" : "SSH", "executionStage" : "POST" }, "preSnapCmdExecEnabled" : true, "postSnapCmdExecEnabled" : true, "preSnapIgnoredExitCodes" : "...", "postSnapIgnoredExitCodes" : "...", "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING", "postSnapStdErrorHandling" : "DONT_IGNORE", "preSnapCmdExecTimeout" : 12345, "postSnapCmdExecTimeout" : 12345, "nodeConfig" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" } }