Snapservice.Reports.Clusters.VirtualMachines.Snapshots.ListItem

Snapservice.Reports.Clusters.VirtualMachines.Snapshots.ListItem
Snapservice.Reports.Clusters.VirtualMachines.Snapshots.ListItem

The Snapservice.Reports.Clusters.VirtualMachines.Snapshots.ListItem schema contains information about a virtual machine snapshot returned by GET /snapservice/reports/clusters/{cluster}/virtual-machines/snapshots operation

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "name": "string",
    "snapshot": "string",
    "pg_snapshot": "string",
    "pg": "string",
    "vm": "string",
    "status": "string",
    "error": {
        "messages": [
            {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi.Std.NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        ]
    },
    "creation_time": "string",
    "expiration_time": "string",
    "snapshot_type": "string",
    "deleted": false
}
string
name
Required

Name of the virtual machine snapshot. If no snapshot is available for virtual machine due to error, a dummy name will be returned.

This property was added in vSphere API 9.0.0.0.

string
snapshot
Optional

Identifier of the virtual machine snapshot.

This property was added in vSphere API 9.0.0.0.

missing or null when virtual machine snapshot operation has failed.

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
pg_snapshot
Required

Identifier of the protection group snapshot.

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

string
pg
Required

ID of the protection group.

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

string
vm
Required

MoRef ID of the virtual machine.

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

Status of the virtual machine snapshot operation.

Possible values:

  • SUCCESS: Virtual machine snapshot is successfully created.
  • ERROR: Virtual machine snapshot has failed.

For more information see: Snapservice.Reports.Clusters.VirtualMachines.Snapshots.Status.

This property was added in vSphere API 9.0.0.0.

error
Optional

Failure reason, if the virtual machine snapshot operation has failed.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is Snapservice.Reports.Clusters.VirtualMachines.Snapshots.Status.ERROR.

string As date-time As date-time
creation_time
Required

Creation time of virtual machine snapshot. If the snapshot operation fails, start time of the operation is returned.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
expiration_time
Optional

Expiration time of virtual machine snapshot.

This property was added in vSphere API 9.0.0.0.

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

string
snapshot_type
Optional

Type of virtual machine snapshot.

Possible values:

  • 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

For more information see: Snapservice.Clusters.VirtualMachines.Snapshots.Type.

This property was added in vSphere API 9.0.0.0.

This property is being kept optional for future use-cases, but mandatory in the current version.

boolean
deleted
Required

Whether the virtual machine snapshot is deleted.

This property was added in vSphere API 9.0.0.0.

Property Of