[Hyper-V] Action

Q100048: [Hyper-V] Action

Changes the run state 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 act on.
Action	In	Choices: `Start`, `Stop`, `Pause`, `Resume`, `Reset`, `Shutdown` Action to perform on the named virtual machine.
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] Action 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 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 Action parameter allows the selection of one of multiple actions to perform.

Action Value	Description of Action
Start	Start the specified VM on the Hyper-V host, if it is not already in a running state.
Stop	Stop the specified VM on the Hyper-V host, if the VM is currently running.
Pause	Pause the specified VM on the Hyper-V host, if the VM is currently running.
Resume	Resume the specified VM on the Hyper-V host, if the VM is currently paused.
Reset	Reset the specified VM on the Hyper-V host.
Shutdown	Shutdown the specified VM on the Hyper-V host.

Last Updated:

10/3/2023 1:07:02 AM