BaseSnapshotInfo

BaseSnapshotInfo
BaseSnapshotInfo

Information related to VM snapshot.

JSON Example 
{
    "created_timestamp": 1582181947320,
    "description": "Base image snapshot",
    "disk_size_mb": 42949,
    "hardware_version": 13,
    "id": "snapshot-4",
    "incompatible_reasons": [
        "string"
    ],
    "max_number_of_monitors": 1,
    "max_resolution_of_any_one_monitor": "1600x1200",
    "memory_mb": 4096,
    "memory_reservation_mb": 0,
    "name": "Snapshot1",
    "path": "/Snapshot1",
    "renderer3d": "DISABLED",
    "total_video_memory_mb": 8,
    "vcenter_id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
    "vgpu_type": "string"
}
integer As int64 As int64
created_timestamp
Optional

Epoch time in milli seconds, when the VM snapshot was created. Supported Filters : 'Between', 'Equals'.

string
description
Optional

Description of the VM snapshot. Supported Filters : 'Equals'.

integer As int64 As int64
disk_size_mb
Optional

Sum of capacities of all the virtual disks in the VM snapshot, in MB. Supported Filters : 'Between','Equals'.

integer As int32 As int32
hardware_version
Optional

VM snapshot hardware version Supported Filters : 'Equals'.

string
id
Optional

Unique ID representing the VM snapshot. Supported Filters : 'Equals'.

array of string
incompatible_reasons
Optional

Reasons that may preclude this VM snapshot from being used in linked/instant clone desktop pool or farm creation. Supported Filters : 'Equals'.

Possible values are : POWERED_ON, INCOMPATIBLE_HARDWARE_VERSION,
integer As int32 As int32
max_number_of_monitors
Optional

Maximum number of monitors set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.

string
max_resolution_of_any_one_monitor
Optional

Maximum resolution of any one monitor set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.

integer As int32 As int32
memory_mb
Optional

The physical memory size of VM snapshot, in MB Supported Filters : 'Equals'.

integer As int64 As int64
memory_reservation_mb
Optional

Amount of memory that is guaranteed available to the virtual machine, in MB. Supported Filters : 'Equals'.

string
name
Optional

VM snapshot name. Supported Filters : 'Equals','StartsWith', 'Contains'.

string
path
Optional

VM snapshot path. Supported Filters : 'Equals'.

string
renderer3d
Optional

Indicate how the virtual video device for the VM snapshot renders 3D graphics. Will be set only if VM snapshot supports 3D functions. Supported Filters : 'Equals'.

  • AUTOMATIC: 3D rendering is automatic.
  • DISABLED: 3D rendering is disabled.
  • 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.
  • MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.
  • SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.
Possible values are : AUTOMATIC, DISABLED, HARDWARE, MANAGE_BY_VSPHERE_CLIENT, SOFTWARE,
number As double As double
total_video_memory_mb
Optional

Total video memory in MB set in SVGA settings for the VM snapshot in vCenter. Supported Filters : 'Equals'.

string
vcenter_id
Optional

Virtual Center id for this VM snapshot. Supported Filters : 'Equals'.

string
vgpu_type
Optional

NVIDIA GRID vGPU type configured on this VM snapshot. Supported Filters : 'Equals'.