[Hyper-V] Checkpoint
Q100049: [Hyper-V] Checkpoint
Manages the checkpoints of a Hyper-V virtual machine.
| Parameter | In/Out | Description | Other Info |
|---|---|---|---|
| Hyper-V Connection | In | Hyper-V Host connection information. | Connection type: sysHyperV |
| VM Name | In | The name of the virtual machine to target. | |
| Checkpoint Name | In | The name of the checkpoint. Leave blank to use most recent for Apply/Delete, default timestamp based name for Create. | |
| Action | In | Choices: Create, Apply, DeleteAction to perform on the named virtual machine. |
|
| Checkpoint Type | In | Choices: Full, DiskThe type of Hyper-V checkpoint (for Create). |
|
| Return Code | Out | Return code from call to service. | |
| Return Message | Out | Returned message from call to service. |
(Italics = required parameters)
Notes
The [Hyper-V] Checkpoint module is useful for both the localhost as well as domain member machines. If the Hyper-V Connection parameter is set to a value of localhost, then the checkpoint actions will take place on the local server that JobServer is running on. Otherwise, the Hyper-V Connection must be defined to include the server name and authorization credentials for an account that has permission on the domain to perform the requested actions.
The VM Name parameter allows the specification of a singular virtual machine on the selected host server. The Checkpoint Name can be specified to set a specific value, or if blank, will use the most recent name for an Apply or Delete action, or will use the default name for a Create action. The Action parameter allows the selection of either the Apply, Create, or Delete actions.