Snapservice Clusters ProtectionGroups Snapshots Info

Snapservice Clusters ProtectionGroups Snapshots Info
Snapservice Clusters ProtectionGroups Snapshots Info

Information regarding a protection group snapshot.

This schema was added in vSphere API 8.0.3.0.

JSON Example
{
    "name": "string",
    "snapshot_type": "string",
    "start_time": "string",
    "end_time": "string",
    "expires_at": "string",
    "pg": "string",
    "vm_snapshots": [
        {
            "snapshot": "string",
            "name": "string",
            "created_at": "string",
            "expires_at": "string",
            "vm": "string"
        }
    ],
    "labels": [
        {
            "category": "string",
            "name": "string"
        }
    ]
}
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
snapshot_type
Required

Snapshot type.

For more information see: Snapservice Clusters ProtectionGroups Snapshots Type.

This property was added in vSphere API 8.0.3.0.

string As date-time As date-time
start_time
Required

Time at which the protection group snapshot operation started.

This property was added in vSphere API 8.0.3.0.

string As date-time As date-time
end_time
Required

Time at which the protection group snapshot operation completed.

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

Identifier of the protection group 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: 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 ProtectionGroups Snapshots VmSnapshotSummary
vm_snapshots
Required

List of virtual machine 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.

This property was added in vSphere API 9.1.0.0.

missing or null if the snapshot does not have any labels this will be empty

Returned By