Snapservice Clusters VirtualMachines Snapshots Info

Snapservice Clusters VirtualMachines Snapshots Info
Snapservice Clusters VirtualMachines Snapshots Info

Information regarding a virtual machine snapshot.

This schema was added in vSphere API 8.0.3.0.

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"
        }
    ],
    "labels": [
        {
            "category": "string",
            "name": "string"
        }
    ]
}
string
name
Required

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

This property was added in vSphere API 8.0.3.0.

string
snapshot_type
Required

Snapshot type.

For more information see: Snapservice Clusters VirtualMachines Snapshots Type.

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.

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.

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.

string
pg
Optional

Identifier of the protection group for which this snapshot was taken.

This property was added in vSphere API 8.0.3.0.

missing or null if the snapshot was not taken as part of a protection group.

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

array of Snapservice Clusters VirtualMachines Disks Snapshots Info
disk_snapshots
Required

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

This property was added in vSphere API 8.0.3.0.

array of Snapservice Snapshots Label
labels
Optional

All the labels associated with this Snapshot. if the snapshot does not have any labels this will be empty

This property was added in vSphere API 9.1.0.0.

This property is optional because it was added in a newer version than its parent node.

Returned By