OSProtectedEntityDetails Data Type

Properties
name data type constraints description
sshHost string  
sshPort number  
credential CredentialDetails  
sshKeyPath string  
backupCount number required
rules array of NameAndGuid  
name string  
type ProtectedEntityType  
locked boolean required
beingDeleted boolean required
osAgent OSAgentDetails  
backupUpToDate boolean  
policy CloudBackupPolicyDetailsWithoutPE  
restorable boolean required
lastSuccessfulBackupSize number  
present boolean required
totalBackupSize number  
lastSuccessfulFullBackupSize number  
description string  
warningsPresent boolean required
lastSuccessfulFullBackup NameAndGuid  
lastSuccessfulIncBackup NameAndGuid  
averageProgress number  
lastChainMarkedForDeletion boolean required
guid string  
lastBackup number  

Example

{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "CERTIFICATE"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_SITE",
  "locked" : true,
  "beingDeleted" : true,
  "osAgent" : {
    "sshHost" : "...",
    "sshPort" : 12345,
    "credential" : {
      "guid" : "...",
      "name" : "...",
      "user" : "...",
      "secretKey" : "...",
      "sshKey" : "...",
      "sshKeyPath" : "...",
      "powerShellTransportType" : "NTLM"
    },
    "sshKeyPath" : "...",
    "backupCount" : 12345,
    "rules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "name" : "...",
    "type" : "STORAGE",
    "backupUpToDate" : true,
    "restorable" : true,
    "lastSuccessfulBackupSize" : 12345,
    "lastSuccessfulFullBackupSize" : 12345,
    "description" : "...",
    "lastLoginDate" : 12345,
    "warningsPresent" : true,
    "status" : "WORKING",
    "lastSuccessfulFullBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "possibleActions" : [ "HVM_READ", "READ" ],
    "lastSuccessfulIncBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "nodeConfig" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "averageProgress" : 12345.0,
    "policy" : {
      "rules" : [ { }, { } ],
      "name" : "...",
      "autoAssignSettings" : { },
      "active" : true,
      "autoRemoveNonPresent" : true,
      "backupRetryCount" : 12345,
      "averageBackupSize" : 12345,
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "failRemainingBackupTasksExportThreshold" : 12345.0,
      "failRemainingBackupTasksStoreThreshold" : 12345.0,
      "priority" : 50,
      "dailyReportEnabled" : true,
      "mailingList" : { }
    },
    "lastChainMarkedForDeletion" : true,
    "enabledScheduledBackups" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "osType" : "WINDOWS",
    "lastBackup" : 1451649601000
  },
  "backupUpToDate" : true,
  "policy" : {
    "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" : [ "...", "..." ],
      "cloudServiceProviders" : [ { }, { } ]
    },
    "autoRemoveNonPresent" : true,
    "averageBackupSize" : 12345,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "backupRetryCount" : 12345,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "cloudFeatures" : [ {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }, {
      "name" : "...",
      "description" : "..."
    } ],
    "objectsTimeRange" : 12345,
    "backupDeletedItemsFolder" : true
  },
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "present" : true,
  "totalBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "description" : "...",
  "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
}