gRPC: vm

Virtual machine lifecycle. Every mutating call is a long-running operation that returns a task id; poll TaskService or watch the inventory.

`VmService`

Life cycle of virtual machines. Every call starts a task and returns its reference.

Method	Request	Response	Description
`CreateVm`	`CreateVmRequest`	`TaskRef`	Creates a virtual machine from a specification.
`DeleteVm`	`VmRequest`	`TaskRef`	Deletes a virtual machine.
`PowerOn`	`VmRequest`	`TaskRef`	Powers a virtual machine on.
`PowerOff`	`VmRequest`	`TaskRef`	Hard power-off, at once; the guest is not asked. Succeeds on a VM that is off.
`Shutdown`	`ShutdownVmRequest`	`TaskRef`	Graceful shutdown: the guest is asked to power off; after the timeout the VM is powered off hard.
`Reset`	`VmRequest`	`TaskRef`	Resets a running virtual machine, as a hardware reset.
`Suspend`	`VmRequest`	`TaskRef`	Suspends a running virtual machine.
`Reconfigure`	`ReconfigureVmRequest`	`TaskRef`	Replaces the VM configuration (`config` object as JSON).

Graceful shutdown of a virtual machine.

Field	Number	Type	Description
`id`	1	`string`	Id of the virtual machine.
`idempotency_key`	2	`string`	Repeating a request with the same key returns the same task.
`timeout_seconds`	3	`uint64`	Seconds the guest gets before the hard power-off (1 to 3600; 0: the default, 90).

Names one virtual machine.

Field	Number	Type	Description
`id`	1	`string`	Id of the virtual machine.
`idempotency_key`	2	`string`	Repeating a request with the same key returns the same task.

Creates a virtual machine.

Field	Number	Type	Description
`folder`	1	`string`	VM folder (group-vN).
`spec_json`	2	`string`	JSON body in the VirtualMachine schema.
`idempotency_key`	3	`string`	Key that makes a retried request create the virtual machine once.

Changes the configuration of a virtual machine.

Field	Number	Type	Description
`id`	1	`string`	Id of the virtual machine.
`config_json`	2	`string`	JSON body in the VmConfig schema.
`idempotency_key`	3	`string`	Key that makes a retried request apply the change once.