Snapservice.Clusters.VirtualMachines.RestoreSpec

The Snapservice.Clusters.VirtualMachines.RestoreSpec schema contains properties to restore deleted virtual machine to a given snapshot point.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "snapshot": "string",
    "name": "string",
    "placement": {
        "folder": "string",
        "resource_pool": "string",
        "host": "string"
    }
}

string

snapshot

Required

Identifier of the virtual machine snapshot using which the virtual machine shall be restored. snapshot must be a snapshot of a virtual machine on the same cluster where virtual machine being restored.

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.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

name

Optional

New name for the virtual machine being restored.

This property was added in vSphere API 8.0.3.0.

If missing or null, will use the name of the virtual machine when the snapshot was taken.

placement

Optional

Virtual machine placement information.

Each field in the spec will be used for placement. If the fields result in disjoint placement the operation will fail.

This property was added in vSphere API 8.0.3.0.

If missing or null, and the cluster is DRS enabled the system will create the virtual machine under the default vitual machine folder. If the DRS is not enabled on the cluster the operation will fail.