BackupFileLocation Data Type

Properties
name data type constraints description
backupDestination BackupDestination  
backupFile BackupFile  
guid string  
status BackupFileLocationStatus  
ver number  
roleType BackupDestinationRole  
backupTime number  
lastModifiedTime number  
encryption number required
config string  
compressionType CompressionType  
path string  
tapeChunks array of TapeChunk  
auditEntityName string  
nameAndGuid NameAndGuid  
nameGuidAndType NameGuidAndType  

Example

{
  "backupDestination" : {
    "guid" : "...",
    "ver" : 12345,
    "nameAndGuid" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "name" : "...",
    "modificationTime" : 12345,
    "dedupEnabled" : true,
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "visibleForAllVms" : true,
    "backupDestinationForCloud" : true,
    "trustAllCerts" : true,
    "nodeConfigs" : [ {
      "guid" : "...",
      "ver" : 12345,
      "backupDestinations" : [ { }, { } ],
      "nodes" : [ { }, { } ],
      "hypervisors" : [ { }, { } ],
      "hypervisorManagers" : [ { }, { } ],
      "storageProviders" : [ { }, { } ],
      "applications" : [ { }, { } ],
      "nameAndGuid" : { },
      "cloudServiceProviders" : [ { }, { } ],
      "hypervisorCluster" : { },
      "nameGuidAndType" : { },
      "tapeManagers" : [ { }, { } ],
      "name" : "...",
      "modificationTime" : 12345,
      "isDefault" : true,
      "generalSettings" : { },
      "threadsSettings" : { },
      "netcatSettings" : { },
      "cloudAgentSettings" : { },
      "auditEntityName" : "...",
      "defaultNode" : { },
      "usedInArchitecture" : true,
      "architectureInfo" : "...",
      "pathableBackupDestinations" : [ { }, { } ]
    }, {
      "guid" : "...",
      "ver" : 12345,
      "backupDestinations" : [ { }, { } ],
      "nodes" : [ { }, { } ],
      "hypervisors" : [ { }, { } ],
      "hypervisorManagers" : [ { }, { } ],
      "storageProviders" : [ { }, { } ],
      "applications" : [ { }, { } ],
      "nameAndGuid" : { },
      "cloudServiceProviders" : [ { }, { } ],
      "hypervisorCluster" : { },
      "nameGuidAndType" : { },
      "tapeManagers" : [ { }, { } ],
      "name" : "...",
      "modificationTime" : 12345,
      "isDefault" : true,
      "generalSettings" : { },
      "threadsSettings" : { },
      "netcatSettings" : { },
      "cloudAgentSettings" : { },
      "auditEntityName" : "...",
      "defaultNode" : { },
      "usedInArchitecture" : true,
      "architectureInfo" : "...",
      "pathableBackupDestinations" : [ { }, { } ]
    } ],
    "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" : { }
    } ],
    "backupDestinationBackups" : [ {
      "guid" : "...",
      "ver" : 12345,
      "backup" : { },
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "status" : "REMOVED",
      "type" : "SYNCHRONIZATION",
      "statusInfo" : "...",
      "retentionHint" : "STANDARD_RETENTION",
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "guid" : "...",
      "ver" : 12345,
      "backup" : { },
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "status" : "REMOVED",
      "type" : "SYNCHRONIZATION",
      "statusInfo" : "...",
      "retentionHint" : "RECREATE",
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "ruleBackupDestinations" : [ {
      "guid" : "...",
      "ver" : 12345,
      "backupDestination" : { },
      "rule" : { },
      "roleType" : "ARCHIVE",
      "active" : true,
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "guid" : "...",
      "ver" : 12345,
      "backupDestination" : { },
      "rule" : { },
      "roleType" : "SECONDARY",
      "active" : true,
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "type" : "NETWORKER",
    "preAccessCmdArgs" : [ "...", "..." ],
    "postAccessCmdArgs" : [ "...", "..." ],
    "preAccessCmdExecEnabled" : true,
    "postAccessCmdExecEnabled" : true,
    "preAccessCmdExecTimeout" : 12345,
    "postAccessCmdExecTimeout" : 12345,
    "backupDestinationInitInfos" : [ {
      "node" : { },
      "backupDestination" : { },
      "initSuccessful" : true,
      "initError" : "...",
      "modificationTime" : 12345,
      "guid" : "...",
      "auditEntityName" : "...",
      "ver" : 12345,
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "node" : { },
      "backupDestination" : { },
      "initSuccessful" : true,
      "initError" : "...",
      "modificationTime" : 12345,
      "guid" : "...",
      "auditEntityName" : "...",
      "ver" : 12345,
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "initRequired" : true,
    "encryptionEnabled" : true,
    "warnings" : [ "...", "..." ],
    "defaultBackupDestination" : true,
    "spaceThreshold" : 12345,
    "description" : "...",
    "state" : "INITIALIZED",
    "auditEntityName" : "...",
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "randomAccessSupported" : true,
    "backups" : [ {
      "guid" : "...",
      "ver" : 12345,
      "nameAndGuid" : { },
      "nameGuidAndType" : { },
      "snapshotTime" : 12345,
      "backupTime" : 12345,
      "archiveExpire" : 12345,
      "size" : 12345,
      "fileCount" : 12345,
      "effectiveBackupObjectsCount" : 12345,
      "effectiveBackupSize" : 12345,
      "hidden" : true,
      "originEntityType" : "SYSTEM_SCHEDULE",
      "originEntityName" : "...",
      "originEntityGuid" : "...",
      "description" : "...",
      "status" : "SUCCESS",
      "statusInfo" : "...",
      "storedBytes" : 12345,
      "backupLocations" : [ { }, { } ],
      "protectedEntity" : { },
      "node" : { },
      "backupRule" : { },
      "protectedEntityType" : "CLOUD_USER",
      "type" : "SYNTHETIC",
      "parentBackup" : { },
      "tasks" : [ { }, { } ],
      "files" : [ { }, { } ],
      "archivedTasks" : [ { }, { } ],
      "vmExportImportMode" : "EXPORT_STORAGE_REPO",
      "warningsPresent" : true,
      "warnings" : [ { }, { } ],
      "baseImage" : { },
      "sourceProject" : { },
      "retentionHint" : "TO_REMOVE",
      "archivedBackup" : { },
      "taskDurationTime" : 12345,
      "auditEntityName" : "...",
      "primaryBackupDestination" : { },
      "primaryLocation" : { },
      "nonPrimaryLocations" : [ { }, { } ],
      "secondaryBackupDestinations" : [ { }, { } ],
      "allBackupDestinations" : [ { }, { } ],
      "networkInterfaceCards" : [ { }, { } ],
      "locationStatuses" : [ "REMOVED", "IN_PROGRESS" ],
      "overallStatus" : "QUEUED",
      "statusBasedOnBackupFileLocations" : "INPROGRESS",
      "agentType" : true,
      "deletable" : true
    }, {
      "guid" : "...",
      "ver" : 12345,
      "nameAndGuid" : { },
      "nameGuidAndType" : { },
      "snapshotTime" : 12345,
      "backupTime" : 12345,
      "archiveExpire" : 12345,
      "size" : 12345,
      "fileCount" : 12345,
      "effectiveBackupObjectsCount" : 12345,
      "effectiveBackupSize" : 12345,
      "hidden" : true,
      "originEntityType" : "SCHEDULE",
      "originEntityName" : "...",
      "originEntityGuid" : "...",
      "description" : "...",
      "status" : "QUEUED",
      "statusInfo" : "...",
      "storedBytes" : 12345,
      "backupLocations" : [ { }, { } ],
      "protectedEntity" : { },
      "node" : { },
      "backupRule" : { },
      "protectedEntityType" : "CLOUD_SITE",
      "type" : "SYNCHRONIZATION",
      "parentBackup" : { },
      "tasks" : [ { }, { } ],
      "files" : [ { }, { } ],
      "archivedTasks" : [ { }, { } ],
      "vmExportImportMode" : "EXPORT_STORAGE_REPO",
      "warningsPresent" : true,
      "warnings" : [ { }, { } ],
      "baseImage" : { },
      "sourceProject" : { },
      "retentionHint" : "DONT_TOUCH",
      "archivedBackup" : { },
      "taskDurationTime" : 12345,
      "auditEntityName" : "...",
      "primaryBackupDestination" : { },
      "primaryLocation" : { },
      "nonPrimaryLocations" : [ { }, { } ],
      "secondaryBackupDestinations" : [ { }, { } ],
      "allBackupDestinations" : [ { }, { } ],
      "networkInterfaceCards" : [ { }, { } ],
      "locationStatuses" : [ "IN_PROGRESS", "REMOVED" ],
      "overallStatus" : "INPROGRESS",
      "statusBasedOnBackupFileLocations" : "FAILED",
      "agentType" : true,
      "deletable" : true
    } ],
    "synthetic" : true,
    "tapePool" : true,
    "assignedToPolicyRules" : true
  },
  "backupFile" : {
    "guid" : "...",
    "ver" : 12345,
    "backupTime" : 12345,
    "lastModifiedTime" : 12345,
    "size" : 12345,
    "effectiveBackupSize" : 12345,
    "effectiveSuccessfulObjects" : 12345,
    "effectiveTotalDirectories" : 12345,
    "effectiveFailedObjects" : 12345,
    "effectiveProcessedDirectories" : 12345,
    "effectiveSkippedObjects" : 12345,
    "path" : "...",
    "originalPath" : "...",
    "mountable" : true,
    "originalStorageId" : "...",
    "originalDiskId" : "...",
    "encryption" : 12345,
    "config" : "...",
    "objectName" : "...",
    "nameAndGuid" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "sessionId" : "...",
    "cloudFeature" : "TEAMS_DOCUMENT_LIBRARY",
    "format" : "VM_META_NUTANIX_INC",
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "underlyingStorageType" : "GCE_PD",
    "compressionType" : "TAR_GZIP",
    "backup" : {
      "guid" : "...",
      "ver" : 12345,
      "nameAndGuid" : { },
      "nameGuidAndType" : { },
      "snapshotTime" : 12345,
      "backupTime" : 12345,
      "archiveExpire" : 12345,
      "size" : 12345,
      "fileCount" : 12345,
      "effectiveBackupObjectsCount" : 12345,
      "effectiveBackupSize" : 12345,
      "hidden" : true,
      "originEntityType" : "SCHEDULE",
      "originEntityName" : "...",
      "originEntityGuid" : "...",
      "description" : "...",
      "status" : "SUCCESS",
      "statusInfo" : "...",
      "storedBytes" : 12345,
      "backupLocations" : [ { }, { } ],
      "protectedEntity" : { },
      "node" : { },
      "backupRule" : { },
      "protectedEntityType" : "CLOUD_SITE",
      "type" : "INCREMENTAL",
      "parentBackup" : { },
      "tasks" : [ { }, { } ],
      "files" : [ { }, { } ],
      "archivedTasks" : [ { }, { } ],
      "vmExportImportMode" : "INHERIT",
      "warningsPresent" : true,
      "warnings" : [ { }, { } ],
      "baseImage" : { },
      "sourceProject" : { },
      "retentionHint" : "ARCHIVE",
      "archivedBackup" : { },
      "taskDurationTime" : 12345,
      "auditEntityName" : "...",
      "primaryBackupDestination" : { },
      "primaryLocation" : { },
      "nonPrimaryLocations" : [ { }, { } ],
      "secondaryBackupDestinations" : [ { }, { } ],
      "allBackupDestinations" : [ { }, { } ],
      "networkInterfaceCards" : [ { }, { } ],
      "locationStatuses" : [ "PRESENT", "PRESENT" ],
      "overallStatus" : "SUCCESS_REMOVED",
      "statusBasedOnBackupFileLocations" : "QUEUED",
      "agentType" : true,
      "deletable" : true
    },
    "parentBackupFile" : { },
    "locations" : [ {
      "backupDestination" : { },
      "backupFile" : { },
      "guid" : "...",
      "status" : "TORECREATE",
      "ver" : 12345,
      "roleType" : "ARCHIVE",
      "backupTime" : 12345,
      "lastModifiedTime" : 12345,
      "encryption" : 12345,
      "config" : "...",
      "compressionType" : "TAR",
      "path" : "...",
      "tapeChunks" : [ { }, { } ],
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    }, {
      "backupDestination" : { },
      "backupFile" : { },
      "guid" : "...",
      "status" : "REMOVED",
      "ver" : 12345,
      "roleType" : "SECONDARY",
      "backupTime" : 12345,
      "lastModifiedTime" : 12345,
      "encryption" : 12345,
      "config" : "...",
      "compressionType" : "TAR_BZIP2",
      "path" : "...",
      "tapeChunks" : [ { }, { } ],
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    } ],
    "lvmType" : true,
    "metadataFormat" : true,
    "diskFormat" : true,
    "restoresTime" : [ 12345, 12345 ],
    "vmDisk" : {
      "name" : "...",
      "uuid" : "...",
      "devicePath" : "...",
      "fullDevicePath" : "...",
      "guid" : "...",
      "ver" : 12345,
      "controllerId" : "...",
      "slot" : "...",
      "size" : 12345,
      "present" : true,
      "excludedFromBackup" : true,
      "bootable" : true,
      "image" : true,
      "volumeSource" : "...",
      "volumeType" : "...",
      "type" : "OPENSTACK_EPHEMERAL",
      "supported" : true,
      "snapshots" : [ { }, { } ],
      "virtualMachine" : { },
      "originalStorage" : { },
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    },
    "auditEntityName" : "..."
  },
  "guid" : "...",
  "status" : "PRESENT",
  "ver" : 12345,
  "roleType" : "PRIMARY",
  "backupTime" : 12345,
  "lastModifiedTime" : 12345,
  "encryption" : 12345,
  "config" : "...",
  "compressionType" : "TAR_GZIP",
  "path" : "...",
  "tapeChunks" : [ {
    "fileIndex" : 12345,
    "filePart" : 12345,
    "effectiveSize" : 12345,
    "checksum" : "...",
    "status" : "PRESENT",
    "tape" : {
      "name" : "...",
      "serialNumber" : "...",
      "totalSpace" : 12345,
      "initialized" : true,
      "state" : "READY",
      "guid" : "...",
      "tapeLibrary" : { },
      "tapeLock" : { },
      "ver" : 12345,
      "tapePoolBackupDestination" : { },
      "tapeLocation" : { },
      "type" : "CLEANING",
      "auditEntityName" : "...",
      "tapeChunks" : [ { }, { } ],
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    },
    "backupFileLocation" : {
      "backupDestination" : { },
      "backupFile" : { },
      "guid" : "...",
      "status" : "TORECREATE",
      "ver" : 12345,
      "roleType" : "ARCHIVE",
      "backupTime" : 12345,
      "lastModifiedTime" : 12345,
      "encryption" : 12345,
      "config" : "...",
      "compressionType" : "TAR_BZIP2",
      "path" : "...",
      "tapeChunks" : [ { }, { } ],
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    },
    "guid" : "...",
    "ver" : 12345,
    "auditEntityName" : "...",
    "nameAndGuid" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }
  }, {
    "fileIndex" : 12345,
    "filePart" : 12345,
    "effectiveSize" : 12345,
    "checksum" : "...",
    "status" : "TO_REMOVE",
    "tape" : {
      "name" : "...",
      "serialNumber" : "...",
      "totalSpace" : 12345,
      "initialized" : true,
      "state" : "READY",
      "guid" : "...",
      "tapeLibrary" : { },
      "tapeLock" : { },
      "ver" : 12345,
      "tapePoolBackupDestination" : { },
      "tapeLocation" : { },
      "type" : "REGULAR",
      "auditEntityName" : "...",
      "tapeChunks" : [ { }, { } ],
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    },
    "backupFileLocation" : {
      "backupDestination" : { },
      "backupFile" : { },
      "guid" : "...",
      "status" : "PRESENT",
      "ver" : 12345,
      "roleType" : "PRIMARY",
      "backupTime" : 12345,
      "lastModifiedTime" : 12345,
      "encryption" : 12345,
      "config" : "...",
      "compressionType" : "TAR",
      "path" : "...",
      "tapeChunks" : [ { }, { } ],
      "auditEntityName" : "...",
      "nameAndGuid" : { },
      "nameGuidAndType" : { }
    },
    "guid" : "...",
    "ver" : 12345,
    "auditEntityName" : "...",
    "nameAndGuid" : {
      "guid" : "...",
      "name" : "..."
    },
    "nameGuidAndType" : {
      "type" : { },
      "guid" : "...",
      "name" : "..."
    }
  } ],
  "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"
  }
}