Snapservice.Clusters.ProtectionGroups.Snapshots.CreateResult

Snapservice.Clusters.ProtectionGroups.Snapshots.CreateResult

The Snapservice.Clusters.ProtectionGroups.Snapshots.CreateResult schema contains information regarding the operation to create protection group snapshot.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "snapshot_type": "string",
    "total_vms": 0,
    "successful_vms": 0,
    "failed_vms": 0,
    "policy": "string",
    "snapshot": "string"
}

string

snapshot_type

Required

Type of the 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.ProtectionGroups.Snapshots.Type.

This property was added in vSphere API 8.0.3.0.

integer As int64 As int64

total_vms

Required

Total number of virtual machines considered for the snapshot operation.

This property was added in vSphere API 8.0.3.0.

integer As int64 As int64

successful_vms

Required

Number of virtual machines that were successfully snapshotted.

This property was added in vSphere API 8.0.3.0.

integer As int64 As int64

failed_vms

Required

Number of virtual machines the system failed to create snapshots for.

This property was added in vSphere API 8.0.3.0.

string

policy

Optional

Name of the snapshot policy this snapshot corresponds to.

This property was added in vSphere API 8.0.3.0.

missing or null if the snapshot was not a scheduled snapshot.

string

snapshot

Required

Identifier of the protection group 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.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.