Snapservice.Clusters.ProtectionGroups.Snapshots.VmSnapshotSummary

Snapservice.Clusters.ProtectionGroups.Snapshots.VmSnapshotSummary
Snapservice.Clusters.ProtectionGroups.Snapshots.VmSnapshotSummary

The Snapservice.Clusters.ProtectionGroups.Snapshots.VmSnapshotSummary schema contains commonly used information about a virtual machine snapshot.

This schema was added in vSphere API 8.0.3.0.

JSON Example
{
    "snapshot": "string",
    "name": "string",
    "created_at": "string",
    "expires_at": "string",
    "vm": "string"
}
string
snapshot
Required

Identifier of the virtual machine snapshot.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.vm.snapshot. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.vm.snapshot.

string
name
Required

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

This property was added in vSphere API 8.0.3.0.

string As date-time As date-time
created_at
Required

Creation time.

This property was added in vSphere API 8.0.3.0.

string As date-time As date-time
expires_at
Optional

Expiry time.

This property was added in vSphere API 8.0.3.0.

missing or null if there is no expiry for the snapshot.

string
vm
Required

Identifier of the virtual machine for which the snapshot was taken.

This property was added in vSphere API 8.0.3.0.

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