XML element Snapshot

Name: Snapshot

Contains snapshot information such as the creation time stamp and size change.

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.domain.Snapshot",
   "cloneReferenceCount": <Number>,
   "createTime": <Date>,
   "creatorName": <String>,
   "description": <String>,
   "expirationTime": <Date>,
   "id": <String>,
   "isCollapsed": <Boolean>,
   "isDeleted": <Boolean>,
   "isLastReplicatedSnapshot": <Boolean>,
   "isOrphaned": <Boolean>,
   "isReplica": <Boolean>,
   "lastUpdatedTime": DateTime,
   "localAlias": <String>,
   "replicaRetentionMinutes": <Number>,
   "replicationId": <Number>,
   "sizeChangedMB": <Number>,
   "sizeChangedPhysicalMB": <Number>,
   "tag": <String>,
   "timeDeleted": <Date>,
   "vcenterInstanceUuid": <String>,
   "vmIsTemplate": <Boolean>,
   "vmName": <String>,
   "consistency": 'CRASH_CONSISTENT' | 'VM_CONSISTENT' | 'APP_CONSISTENT',
   "deletionPolicy": 'DELETE_ON_EXPIRATION' | 'DELETE_ON_ZERO_CLONE_REFERENCES' | 'DELETE_ON_SYNCREPL_RESYNC_COMPLETE',
   "hypervisorType": 'VMWARE' | 'RHEV' | 'HYPERV' | 'UNKNOWN' | 'OPENSTACK' | 'XENSERVER' | 'VMWARE_VVOL',
   "snapshotComposition": SnapshotComposition,
   "type": 'SCHEDULED_SNAPSHOT' | 'USER_GENERATED_SNAPSHOT' | 'AUTO_GENERATED_CLONING_SNAPSHOT' | 'VAAI_GENERATED_SNAPSHOT' | 'ODX_GENERATED_SNAPSHOT' | 'CINDER_GENERATED_SNAPSHOT' | 'SCHEDULED_HIGH_FREQUENCY_SNAPSHOT' | 'HYPERV_SHARE_SNAPSHOT' | 'SYNCREPL_RESYNC_SNAPSHOT',
   "uuid": Uuid,
   "vmUuid": Uuid,
}

Elements

Name

Type

Description

consistency

CRASH_CONSISTENT | VM_CONSISTENT | APP_CONSISTENT

The consistency type. Crash consistency is a VMstore snapshot that can be used to recover from a VM crash. VM consistency is a hypervisor snapshot that is hypervisor consistent and can be used to recover from a VM crash. App consistency is not used at this time.

CRASH_CONSISTENT	Disk activity quiesed snapshot
VM_CONSISTENT	VM activity quiesed snapshot
APP_CONSISTENT	Application activity quiesed snapshot (currently not used)

deletionPolicy

DELETE_ON_EXPIRATION | DELETE_ON_ZERO_CLONE_REFERENCES | DELETE_ON_SYNCREPL_RESYNC_COMPLETE

The snapshot deletion policy: delete when retention minutes exprire or when there are zero clone references.

DELETE_ON_EXPIRATION	Delete snapshot when expirationTime is reached
DELETE_ON_ZERO_CLONE_REFERENCES	Delete snapshot when there are no clones
DELETE_ON_SYNCREPL_RESYNC_COMPLETE	Delete snapshot by filesystem when Synchronous Replication resync is completed

hypervisorType

The hypervisor type: VMware, RHEV, HyperV, OpenStack, XenServer, VVol, or unknown.

VMWARE	VMware hypervisor
RHEV	Red Hat hypervisor
HYPERV	Microsoft hypervisor
UNKNOWN	Unknown hypervisor
OPENSTACK	OpenStack platform
XENSERVER	Citrix hypervisor
VMWARE_VVOL	VMware virtual volume

snapshotComposition

SnapshotComposition

The snapshot compostion which consists of total snapshot size and a replica map. Used only by TGC.

type

The snapshot type.

SCHEDULED_SNAPSHOT	Snapshots created from a snapshot schedule.
USER_GENERATED_SNAPSHOT	Snapshots created manually by a user.
AUTO_GENERATED_CLONING_SNAPSHOT	Snapshots created as a part of Tintri clones.
VAAI_GENERATED_SNAPSHOT	Snapshots created on Tintri VMstore using VAAI plugin to facilitate VMware clone operation.
ODX_GENERATED_SNAPSHOT	Snapshots for files that get copied onto Vmstore using ODX(Offline Data Transfer).
CINDER_GENERATED_SNAPSHOT	Snapshots for cinder volumes.
SCHEDULED_HIGH_FREQUENCY_SNAPSHOT	Snapshots created at a high frequency schedule.
HYPERV_SHARE_SNAPSHOT	Snapshots for Hyper-V shares, for the purpose of backup.
SYNCREPL_RESYNC_SNAPSHOT	Snapshot for Synchronous Replication (resync).

uuid

Uuid

Unique Tintri UUID for the object

vmUuid

Uuid

The source VM Tintri UUID. It can be null in some cases for a VAAI snapshot.

Attributes
Name	Type	Description
cloneReferenceCount	xsd:int	The clone reference count for this snapshot. The range is 0..2^31-1; however, others limits will be reached before this limit is reached.
createTime	xsd:datetime	The snapshot creation time specified as the number of milliseconds since January 1, 1970.
creatorName	xsd:string	The snapshot creator's name.
description	xsd:string	The snapshot description.
expirationTime	xsd:datetime	The snapshot expiration date specified as the number of milliseconds since January 1, 1970.
id	xsd:string	Returns the global snapshot ID. At this time, Tintri use only.
isCollapsed	xsd:boolean	'True' indicates that the snapshot is collapsed. 'False' indicates that the snapshot has not been collapsed. Tintri use only at this time.
isDeleted	xsd:boolean	'True' indicates that the snapshot is deleted, while 'False' indicates that the snapshot is not deleted.
isLastReplicatedSnapshot	xsd:boolean	'True' indicates that the snapshot is the last replicated snapshot, while 'False' indicates that the snapshot is not the last replicated snapshot.
isOrphaned	xsd:boolean	'True' indicates that the snapshot's source is not available or orphaned, while 'False' indicates that the snapshot's source is available or not orphaned.
isReplica	xsd:boolean	'True' indicates that the snapshot is a replica. 'False' indicates that the snapshot is not a replica.
lastUpdatedTime	DateTime	Last time the entity is updated in the format YYYY-MM-DDThh:mm:ss.ms-/+zz:zz
localAlias	xsd:string	Alias used for the entity instance in this Tintri API server. If an alias is not set, then localAlias is not returned.
replicaRetentionMinutes	xsd:long	The number of minutes that the replica is to be retained before removing it.
replicationId	xsd:long	Deprecated. Deprecated since v310.61. Please see the elements configurationsIncoming and configurationsOutgoing in
sizeChangedMB	xsd:double	Total size changed in MiB from the last snapshot.
sizeChangedPhysicalMB	xsd:double	Physical size changed in MiB from the last snapshot.
tag	xsd:string	The comma delimited snapshot metadata. It contains information about the snapshot like the VVOL ID or whether the files used for the snapshot are not up-to-date using keywords. i.e. stale_ss_files,vvol:id123 This example means it lost it's hypervisor connection and the snapshot is a VVOL snapshot type.
timeDeleted	xsd:datetime	The snapshot deleted date specified in milliseconds since January 1, 1970.
vcenterInstanceUuid	xsd:string	The vCenter instance UUID.
vmIsTemplate	xsd:boolean	'True' indicates that the snapshot's source VM is a template. 'False' indicates that the snapshot's source VM is not a template.
vmName	xsd:string	Snaphot's source VM name.