OSAgentDetails 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  
backupUpToDate boolean  
restorable boolean required
lastSuccessfulBackupSize number  
lastSuccessfulFullBackupSize number  
description string  
lastLoginDate number  
warningsPresent boolean required
status OSAgentStatus  
lastSuccessfulFullBackup NameAndGuid  
possibleActions array of RbacInstanceAction  
lastSuccessfulIncBackup NameAndGuid  
nodeConfig NameAndGuid  
averageProgress number  
policy OSBackupPolicyDetailsWithoutPE  
lastChainMarkedForDeletion boolean required
enabledScheduledBackups boolean required
guid string  
osType OSType  
lastBackup number  

Example

{
  "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" : "CLOUD_TEAMS",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "description" : "...",
  "lastLoginDate" : 12345,
  "warningsPresent" : true,
  "status" : "DECOMMISSIONED",
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "possibleActions" : [ "HV_READ", "HV_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" : [ {
      "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" : "...",
    "autoAssignSettings" : {
      "mode" : "DISABLED",
      "includeRegExps" : [ "...", "..." ],
      "osAgents" : [ { }, { } ]
    },
    "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" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }
  },
  "lastChainMarkedForDeletion" : true,
  "enabledScheduledBackups" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "osType" : "WINDOWS",
  "lastBackup" : 1451649601000
}