Skip to content

Data Object - BaseImageSnapshotInfo

Java Class

com.omnissa.vdi.vlsi.binding.vdi.utils.virtualcenter.BaseImageSnapshot.BaseImageSnapshotInfo

Returned by

BaseImageSnapshot_List

See also

BaseImageSnapshotId, BaseImageSnapshotIncompatibleReasons, VirtualCenterId

Since

Horizon View 6.0

Data Object Description

BaseImageSnapshotInfo is a set of VM snapshot attributes retrieved from the VC.

Data Object Properties

Name Type Description
id BaseImageSnapshotId VM Snapshot Id 2
name xsd:string VM Snapshot name 2
path xsd:string VM Snapshot path 2
virtualCenter VirtualCenterId VirtualCenter id for this snapshot 2
description xsd:string Description of the snapshot. 1 2
createTime xsd:dateTime Time the snapshot was created. 1 2
hardwareVersion xsd:int VM Snapshot hardware version. 1 2
vGPUType xsd:string NVIDIA GRID vGPU type configured on this snapshot, if any. Since Horizon View 6.1 1 2
maxNumberOfMonitors xsd:int Maximum number of monitors set in SVGA settings for the snapshot in vCenter. Since Horizon 7.4 1 2
totalVideoMemoryMB xsd:double Total video memory in MB set in SVGA settings for the snapshot in vCenter. Since Horizon 7.4 1 2
maxResolutionOfAnyOneMonitor xsd:string Maximum resolution of any one monitor set in SVGA settings for the snapshot in vCenter. Since Horizon 7.4 1 2
enable3DSupport xsd:boolean Flag to indicate whether the virtual video card for the snapshot supports 3D functions. Since Horizon 7.6 1 2
renderer3D xsd:string Indicate how the virtual video device for the snapshot renders 3D graphics. Will be set only if enable3DSupport is true. Since Horizon 7.6 3 1 2
* This property will be one of:
ValueDescription
"MANAGE_BY_VSPHERE_CLIENT"3D rendering managed by vSphere Client.
"AUTOMATIC"3D rendering is automatic.
"SOFTWARE"3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
"HARDWARE"3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.
"DISABLED"3D rendering is disabled.
incompatibleReasons BaseImageSnapshotIncompatibleReasons Reasons that may preclude this BaseImageSnapshot from being used in linked clone desktop or farm creation. 2
memoryMB xsd:int Memory size of the snapshot, in MB. Since Horizon 7.4 1 2
diskSizeInBytes xsd:long Sum of capacities of all the virtual disks in the snapshot, in bytes. Since Horizon 7.4 1 2
memoryReservationMB xsd:long Amount of memory that is guaranteed available to the virtual machine, in MB. Since Horizon 7.4 1 2
refId xsd:string Reference ID used for this base image snapshot. Since Horizon 8.1 1 2
carbonBlackReadyToClone xsd:boolean Indicates Carbon Black scan is complete and is ready to clone for Instant Clone desktop or farm creation. Since Horizon 8.4 1 2
carbonBlackScanPercentage xsd:int Carbon Black scan completion percentage. Since Horizon 8.4 1 2 4 5

  1. This property need not be set. 

  2. This property cannot be updated. 

  3. This property has a default value of 'DISABLED'. 

  4. This property has a minimum value of 0. 

  5. This property has a maximum value of 100.