Snapservice VirtualMachines Snapshots ListItem

Snapservice VirtualMachines Snapshots ListItem
Snapservice VirtualMachines Snapshots ListItem

The Snapservice VirtualMachines Snapshots ListItem schema contains information about a virtual machine snapshot returned by GET /snapservice/virtual-machines/snapshots operation

This schema was added in vSphere API 9.1.0.0.

JSON Example
{
    "name": "string",
    "snapshot": "string",
    "vm": "string",
    "vm_bios_uuid": "string",
    "creation_time": "string",
    "expiration_time": "string",
    "snapshot_type": "string",
    "labels": [
        {
            "category": "string",
            "name": "string"
        }
    ]
}
string
name
Required

Name of the virtual machine snapshot.

This property was added in vSphere API 9.1.0.0.

string
snapshot
Required

Identifier of the virtual machine snapshot.

This property was added in vSphere API 9.1.0.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
vm
Required

Identifier of the virtual machine.

This property was added in vSphere API 9.1.0.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
vm_bios_uuid
Optional

BIOS identifier of the virtual machine.

This property was added in vSphere API 9.1.0.0.

If missing or null or empty, virtual machines with any BIOS identifier match the filter.

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 As date-time As date-time
creation_time
Required

Creation time of virtual machine snapshot. Time is in UTC format. If the snapshot operation fails, start time of the operation is returned.

This property was added in vSphere API 9.1.0.0.

string As date-time As date-time
expiration_time
Optional

Expiration time of virtual machine snapshot. Time is in UTC format.

This property was added in vSphere API 9.1.0.0.

If missing or null no expiry time is set for the virtual machine snapshot.

string
snapshot_type
Required

Type of virtual machine snapshot.

For more information see: Snapservice Clusters VirtualMachines Snapshots Type.

This property was added in vSphere API 9.1.0.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.

Property Of