Clusters_VirtualMachines_Snapshots_Info

Clusters_VirtualMachines_Snapshots_Info
Clusters_VirtualMachines_Snapshots_Info

Information regarding a virtual machine snapshot.

JSON Example
{
    "name": "string",
    "snapshot_type": "string",
    "created_at": "string",
    "expires_at": "string",
    "vm": "string",
    "pg": "string",
    "disk_snapshots": [
        {
            "disk_key": 0,
            "sequence_uuid": "string",
            "epoch": 0,
            "uri": "string"
        }
    ]
}
string
name
Required

Snapshot name. For a snapshot triggered by a periodic schedule, name will be system generated.

snapshot_type
Required

The Snapshots.Type enumeration contains valid snapshot types.
SCHEDULED : Indicates that a snapshot was taken as part of a periodic schedule.
ONE_TIME : Indicates that the snapshot was taken as a one time operation triggered by the user.
SYSTEM_CREATED : Indicates that the snapshot was taken by the system

string As date-time
created_at
Required

Creation time.

string As date-time
expires_at
Optional

Expiry time. unset if there is no expiry for the snapshot.

string
vm
Required

Identifier of the virtual machine for which the snapshot was taken. TODO: Remove this once the VM snapshot List/Get is implemented, We do not need this since the query is already being performed on a specific VM.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.

string
pg
Optional

Identifier of the protection group for which this snapshot was taken. unset if the snapshot was not taken as part of a protection group. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.snapservice.protection_group. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.snapservice.protection_group.

disk_snapshots
Required

List of virtual machine disk snapshots that were taken for this snapshot instance.